eQuipAPI

<back to all web services

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}/locationsReturns all location for a specific site.
All Verbs/GetAllLocationsBySite/{UserID}/{siteIDInternal}
GetAllLocationsBySite Parameters:
NameParameterData TypeRequiredDescription
UserIDGuidstringYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
siteIDInternalGuidstringYesThe internal ID of a site used to filter locations.
PageOffsetqueryintNoThe page offset to start retrieving data. 0 returns all entries.
PageSizequeryintNoNumber of entries to return. 0 returns all entries.

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"UserID":"String","siteIDInternal":"String","PageOffset":0,"PageSize":0}
HTTP/1.1 200 OK
Content-Type: application/json
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}