| GET | /sites/{SiteID}/locations | Finds locations by site. | |
|---|---|---|---|
| GET | /sites/locations | Finds all locations across all sites. | |
| All Verbs | /GetAllLocations |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserID | query | Guid | Yes | The UserID that authorizes the caller to complete the request. Contact your eQuip admin. |
| SiteID | path | Guid | No | The internal ID of a site used to filter locations. See Api: FindSites |
| LastLocationIDInternal | query | Guid | No | The internal ID of a specific location. |
| LastSyncDate | query | string | No | Last Sync Date |
| MobileSite | query | boolean | No | True to return sites authorized for mobile operations. |
| PageSize | query | int | No | Number of locations to return. 0 returns all entries. |
| PageOffset | query | int | No | The page offset to start retrieving data. 0 returns first page entries. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetAllLocations HTTP/1.1
Host: equipstage3.e-isg.com
Content-Type: application/xml
Content-Length: length
<GetAllLocations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
<LastLocationIDInternal>String</LastLocationIDInternal>
<LastSyncDate>String</LastSyncDate>
<MobileSite>false</MobileSite>
<PageOffset>0</PageOffset>
<PageSize>0</PageSize>
<SiteID>00000000-0000-0000-0000-000000000000</SiteID>
<UserID>String</UserID>
</GetAllLocations>
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>