eQuipAPI

GetAllLocationsBySite

Returns all location for a specific site; requires a valid userId and siteId to authorize the caller to complete this request.

The following routes are available for this service:
GET	/sites/{siteIDInternal}/locations	Returns all location for a specific site.
All Verbs	/GetAllLocationsBySite/{UserID}/{siteIDInternal}

**GetAllLocationsBySite** Parameters:
Name	Parameter	Data Type	Required	Description
UserID	Guid	string	Yes	The UserID that authorizes the caller to complete the request. Contact your eQuip admin.
siteIDInternal	Guid	string	Yes	The internal ID of a site used to filter locations.
PageOffset	query	int	No	The page offset to start retrieving data. 0 returns all entries.
PageSize	query	int	No	Number of entries to return. 0 returns all entries.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetAllLocationsBySite HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<GetAllLocationsBySite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <PageOffset>0</PageOffset>
  <PageSize>0</PageSize>
  <UserID>String</UserID>
  <siteIDInternal>String</siteIDInternal>
</GetAllLocationsBySite>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Location xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <FileLocatorCode>String</FileLocatorCode>
  <Latitude>0</Latitude>
  <LocationBarcode>String</LocationBarcode>
  <LocationCategoryIDInternal>String</LocationCategoryIDInternal>
  <LocationDescription>String</LocationDescription>
  <LocationIDInternal>String</LocationIDInternal>
  <LocationName>String</LocationName>
  <Longitude>0</Longitude>
  <ModifiedOn>0001-01-01T00:00:00</ModifiedOn>
  <SiteIDInternal>String</SiteIDInternal>
</Location>