GET location/{apiKey}/getlocations

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of LocationList
NameDescriptionTypeAdditional information
locationid

integer

None.

parentlocationid

integer

None.

name

string

None.

locationkey

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "locationid": 1,
    "parentlocationid": 1,
    "name": "sample string 2",
    "locationkey": "sample string 3"
  },
  {
    "locationid": 1,
    "parentlocationid": 1,
    "name": "sample string 2",
    "locationkey": "sample string 3"
  }
]

text/xml

Sample:
<ArrayOflocationlist xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <locationlist>
    <locationid>1</locationid>
    <locationkey>sample string 3</locationkey>
    <name>sample string 2</name>
    <parentlocationid>1</parentlocationid>
  </locationlist>
  <locationlist>
    <locationid>1</locationid>
    <locationkey>sample string 3</locationkey>
    <name>sample string 2</name>
    <parentlocationid>1</parentlocationid>
  </locationlist>
</ArrayOflocationlist>