eQuipAPI

<back to all web services

GetAllLocations

Finds all locations across all sites; Requires a valid user to complete this request.

The following routes are available for this service:
GET/sites/{SiteID}/locationsFinds locations by site.
GET/sites/locationsFinds all locations across all sites.
All Verbs/GetAllLocations
GetAllLocations Parameters:
NameParameterData TypeRequiredDescription
UserIDqueryGuidYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SiteIDpathGuidNoThe internal ID of a site used to filter locations. See Api: FindSites
LastLocationIDInternalqueryGuidNoThe internal ID of a specific location.
LastSyncDatequerystringNoLast Sync Date
MobileSitequerybooleanNoTrue to return sites authorized for mobile operations.
PageSizequeryintNoNumber of locations to return. 0 returns all entries.
PageOffsetqueryintNoThe 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 .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/GetAllLocations HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
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/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
}