eQuipAPI

<back to all web services

GetAllSites

Returns all sites; requires a valid userId to authorize the caller to complete this request.

The following routes are available for this service:
All Verbs/GetAllSites/{UserID}
All Verbs/GetAllSites/{UserID}/{MobileSite}
GET/sitesReturns all sites.
GetAllSites Parameters:
NameParameterData TypeRequiredDescription
UserIDGuidstringYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
MobileSitebitstringNoTrue to return sites authorized for mobile operations.
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/GetAllSites HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: text/jsv
Content-Length: length

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

{
	SiteCode: String,
	SiteDescription: String,
	SiteIDInternal: String,
	SiteName: String,
	CreatedBy: 0,
	CreatedDate: 0001-01-01,
	UpdatedBy: 0,
	UpdatedDate: 0001-01-01
}