POST location/{apiKey}/add

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

string

None.

Body Parameters

InsertLocationModel
NameDescriptionTypeAdditional information
LocationName

string

None.

ParentLocationID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "LocationName": "sample string 1",
  "ParentLocationID": 1
}

text/xml

Sample:
<InsertLocationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <LocationName>sample string 1</LocationName>
  <ParentLocationID>1</ParentLocationID>
</InsertLocationModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InsertLocationModel'.

Response Information

Resource Description

LocationAddResult
NameDescriptionTypeAdditional information
LocationID

integer

None.

status

string

None.

request_length

decimal number

None.

message

string

None.

ipaddress

string

None.

Response Formats

application/json, text/json

Sample:
{
  "LocationID": 1,
  "status": "sample string 2",
  "request_length": 3.1,
  "message": "sample string 4",
  "ipaddress": "sample string 5"
}

text/xml

Sample:
<location_add_result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <ipaddress>sample string 5</ipaddress>
  <message>sample string 4</message>
  <request_length>3.1</request_length>
  <status>sample string 2</status>
  <LocationID>1</LocationID>
  <LocationKey i:nil="true" />
</location_add_result>