GET api/Commodity/{auth}
Retrive a list of commodities (with UN#)
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
auth |
Authenication token |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
CommodityRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
Items |
List of commodities |
Collection of CommodityItem |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorMessage": "sample string 2", "IsSuccessful": true, "Items": [ { "CommodityClass": "sample string 6", "CommodityGUID": "sample string 1", "CommoditySource": "sample string 7", "Instructions": "sample string 3", "IsDangerousGoods": true, "IsRadioactive": true, "ProperName": "sample string 2", "UNNumber": "sample string 4" }, { "CommodityClass": "sample string 6", "CommodityGUID": "sample string 1", "CommoditySource": "sample string 7", "Instructions": "sample string 3", "IsDangerousGoods": true, "IsRadioactive": true, "ProperName": "sample string 2", "UNNumber": "sample string 4" } ] }
application/xml, text/xml
Sample:
<CommodityResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <Items> <CommodityItem> <CommodityClass>sample string 6</CommodityClass> <CommodityGUID>sample string 1</CommodityGUID> <CommoditySource>sample string 7</CommoditySource> <Instructions>sample string 3</Instructions> <IsDangerousGoods>true</IsDangerousGoods> <IsRadioactive>true</IsRadioactive> <ProperName>sample string 2</ProperName> <UNNumber>sample string 4</UNNumber> </CommodityItem> <CommodityItem> <CommodityClass>sample string 6</CommodityClass> <CommodityGUID>sample string 1</CommodityGUID> <CommoditySource>sample string 7</CommoditySource> <Instructions>sample string 3</Instructions> <IsDangerousGoods>true</IsDangerousGoods> <IsRadioactive>true</IsRadioactive> <ProperName>sample string 2</ProperName> <UNNumber>sample string 4</UNNumber> </CommodityItem> </Items> </CommodityResp>