| GET | /sites/locations/v2 | Finds all locations | |
|---|---|---|---|
| GET | /sites/{SiteID}/locations/v2 | Finds locations by site. |
| 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 |
| 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/FindLocations HTTP/1.1
Host: equipstage3.e-isg.com
Content-Type: text/csv
Content-Length: length
{"UserID":"String","SiteID":"00000000000000000000000000000000","PageSize":0,"PageOffset":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"LocationID":0,"LocationCategoryID":0,"UL_LocationID":0,"SiteID":0,"PlanID":0,"ZoneID":0,"LocationBarcode":"String","LocationName":"String","LocationDescription":"String","LocationX":0,"LocationY":0,"Width":0,"Height":0,"SizeType":"String","Opacity":"String","Color":"String","DisplayOnScanner":false,"FileLocatorCode":"String","DateCreated":"\/Date(-62135596800000-0000)\/","DateModified":"\/Date(-62135596800000-0000)\/","UseMap":false,"CustomFields":[{"FieldName":"String","FieldValue":{}}]}