eQuipAPI

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	/sites	Returns all sites.

**GetAllSites** Parameters:
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 .xml suffix or ?format=xml

HTTP + XML

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

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

<GetAllSites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <MobileSite>false</MobileSite>
  <PageOffset>0</PageOffset>
  <PageSize>0</PageSize>
  <UserID>String</UserID>
</GetAllSites>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Site xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <CreatedBy>0</CreatedBy>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <SiteCode>String</SiteCode>
  <SiteDescription>String</SiteDescription>
  <SiteIDInternal>String</SiteIDInternal>
  <SiteName>String</SiteName>
  <UpdatedBy>0</UpdatedBy>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</Site>