POST api/v1/WH_Area

Retrieve details of all areas for a given warehouse

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
WarehouseID		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2
}

application/xml, text/xml

Sample:

<WH_Area_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <WarehouseID>2</WarehouseID>
</WH_Area_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of areas
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content
503 Service Unavailable

WH_Areas

Name	Description	Type	Additional information
WH_AreaList		Collection of WH_Area	None.

Response Formats

application/json, text/json

Sample:

{
  "WH_AreaList": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Areas xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WH_Area>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </WH_Area>
  <WH_Area>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </WH_Area>
</WH_Areas>