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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/GetAllLocationsBySite HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/jsv
Content-Length: length

{
	UserID: String,
	siteIDInternal: String,
	PageOffset: 0,
	PageSize: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	LocationName: String,
	LocationDescription: String,
	LocationBarcode: String,
	LocationIDInternal: String,
	LocationCategoryIDInternal: String,
	SiteIDInternal: String,
	ModifiedOn: 0001-01-01,
	FileLocatorCode: String,
	Latitude: 0,
	Longitude: 0
}