GET api/accounts/{accountID}/locations?regCode={regCode}

Get a list of all Locations for an Account

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

The accountID of the account for which a list of locations is requested.

string

Required

regCode

The registration code assigned to the tablet. Contained in RegistrationToken returned by "RequestRegistrationToken"

string

None.

Body Parameters

None.

Response Information

Resource Description

Get a list of all Locations for an Account

Collection of LocationInfo
NameDescriptionTypeAdditional information
LocationID

string

None.

AccountID

string

None.

Name

string

None.

Description

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "LocationID": "sample string 1",
    "AccountID": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4"
  },
  {
    "LocationID": "sample string 1",
    "AccountID": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4"
  }
]

text/html

Sample:
[{"LocationID":"sample string 1","AccountID":"sample string 2","Name":"sample string 3","Description":"sample string 4"},{"LocationID":"sample string 1","AccountID":"sample string 2","Name":"sample string 3","Description":"sample string 4"}]

application/xml, text/xml

Sample:
<ArrayOfLocationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GI.Tablet.Interface">
  <LocationInfo>
    <AccountID>sample string 2</AccountID>
    <Description>sample string 4</Description>
    <LocationID>sample string 1</LocationID>
    <Name>sample string 3</Name>
  </LocationInfo>
  <LocationInfo>
    <AccountID>sample string 2</AccountID>
    <Description>sample string 4</Description>
    <LocationID>sample string 1</LocationID>
    <Name>sample string 3</Name>
  </LocationInfo>
</ArrayOfLocationInfo>