POST api/v1/WH_Aisle
Retrieve details of all aisles for a given warehouse
Request Information
URI Parameters
None.
Body Parameters
WH_Aisle_ParamsName | 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_Aisle_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_Aisle_Params>
Response Information
Resource Description
Returns:
200 OK Returns a collection of aisles
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
Name | Description | Type | Additional information |
---|---|---|---|
WH_AisleList | Collection of WH_Aisle |
None. |
Response Formats
application/json, text/json
Sample:
{ "WH_AisleList": [ { "Code": "sample string 1", "Description": "sample string 2" }, { "Code": "sample string 1", "Description": "sample string 2" } ] }
application/xml, text/xml
Sample:
<WH_Aisles xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <WH_Aisle> <Code>sample string 1</Code> <Description>sample string 2</Description> </WH_Aisle> <WH_Aisle> <Code>sample string 1</Code> <Description>sample string 2</Description> </WH_Aisle> </WH_Aisles>