eQuipAPI

FindLocations

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

The following routes are available for this service:
GET	/sites/locations/v2	Finds all locations
GET	/sites/{SiteID}/locations/v2	Finds locations by site.

**FindLocations** Parameters:
Name	Parameter	Data Type	Required	Description
UserID	query	Guid	Yes	The UserID that authorizes the caller to complete the request. Contact your eQuip admin.
SiteID	path	Guid	No	The internal ID of a site used to filter locations. See Api: FindSites
PageSize	query	int	No	Number of locations to return. 0 returns all entries.
PageOffset	query	int	No	The 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 .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/FindLocations HTTP/1.1 
Host: equipstage3.e-isg.com 
Content-Type: application/xml
Content-Length: length

<FindLocations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <PageOffset>0</PageOffset>
  <PageSize>0</PageSize>
  <SiteID>00000000-0000-0000-0000-000000000000</SiteID>
  <UserID>String</UserID>
</FindLocations>

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

<LocationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <Color>String</Color>
  <CustomFields>
    <CustomKeyPair>
      <FieldName>String</FieldName>
      <FieldValue />
    </CustomKeyPair>
  </CustomFields>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <DateModified>0001-01-01T00:00:00</DateModified>
  <DisplayOnScanner>false</DisplayOnScanner>
  <FileLocatorCode>String</FileLocatorCode>
  <Height>0</Height>
  <LocationBarcode>String</LocationBarcode>
  <LocationCategoryID>0</LocationCategoryID>
  <LocationDescription>String</LocationDescription>
  <LocationID>0</LocationID>
  <LocationName>String</LocationName>
  <LocationX>0</LocationX>
  <LocationY>0</LocationY>
  <Opacity>String</Opacity>
  <PlanID>0</PlanID>
  <SiteID>0</SiteID>
  <SizeType>String</SizeType>
  <UL_LocationID>0</UL_LocationID>
  <UseMap>false</UseMap>
  <Width>0</Width>
  <ZoneID>0</ZoneID>
</LocationDto>