POST api/v1/WH_HandlingArea

Retrieve details of all handling 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
Kind	0 internal use, 1 Pick Bays, 2 Loading Bays, 3 Vehicles, leave null for all	integer	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<WH_HandlingArea_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>
  <Kind>1</Kind>
</WH_HandlingArea_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of handling 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_HandlingAreas

Name	Description	Type	Additional information
WH_HandlingAreaList		Collection of WH_HandlingArea	None.

Response Formats

application/json, text/json

Sample:

{
  "WH_HandlingAreaList": [
    {
      "ID": 1,
      "Description": "sample string 2",
      "Kind": 64
    },
    {
      "ID": 1,
      "Description": "sample string 2",
      "Kind": 64
    }
  ]
}

application/xml, text/xml

Sample:

<WH_HandlingAreas xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WH_HandlingArea>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Kind>64</Kind>
  </WH_HandlingArea>
  <WH_HandlingArea>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Kind>64</Kind>
  </WH_HandlingArea>
</WH_HandlingAreas>