| All Verbs | /GetAllSites/{UserID} | ||
|---|---|---|---|
| All Verbs | /GetAllSites/{UserID}/{MobileSite} | ||
| GET | /sites | Returns all sites. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserID | Guid | string | Yes | The UserID that authorizes the caller to complete the request. Contact your eQuip admin. |
| MobileSite | bit | string | No | True to return sites authorized for mobile operations. |
| PageOffset | query | int | No | The page offset to start retrieving data. 0 returns all entries. |
| PageSize | query | int | No | Number 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
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: equipstage2.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
}