| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/GetAllLocations HTTP/1.1
Host: equipstage3.e-isg.com
Content-Type: text/csv
Content-Length: length
{"UserID":"String","SiteID":"00000000000000000000000000000000","LastLocationIDInternal":"String","LastSyncDate":"String","MobileSite":false,"PageSize":0,"PageOffset":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"LocationName":"String","LocationDescription":"String","LocationBarcode":"String","LocationIDInternal":"String","LocationCategoryIDInternal":"String","SiteIDInternal":"String","ModifiedOn":"\/Date(-62135596800000-0000)\/","FileLocatorCode":"String","Latitude":0,"Longitude":0}