eQuipAPI

<back to all web services

GetAllLocationsBySite

Returns all location for a specific site; requires a valid userId and siteId to authorize the caller to complete this request.

GetAllLocationsBySite Parameters:
NameParameterData TypeRequiredDescription
UserIDGuidstringYesThe UserID that authorizes the caller to complete the request. Contact your eQuip admin.
siteIDInternalGuidstringYesThe internal ID of a site used to filter locations.
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 .soap12 suffix or ?format=soap12

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: equipstage2.e-isg.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

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

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<Location xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eQuipModel">
  <FileLocatorCode>String</FileLocatorCode>
  <Latitude>0</Latitude>
  <LocationBarcode>String</LocationBarcode>
  <LocationCategoryIDInternal>String</LocationCategoryIDInternal>
  <LocationDescription>String</LocationDescription>
  <LocationIDInternal>String</LocationIDInternal>
  <LocationName>String</LocationName>
  <Longitude>0</Longitude>
  <ModifiedOn>0001-01-01T00:00:00</ModifiedOn>
  <SiteIDInternal>String</SiteIDInternal>
</Location>

    </soap12:Body>
</soap12:Envelope>