GET v1/cargoes/{companyCode}?apiToken={apiToken}

Returns a list of all active cargoes associated with a specific company

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

The company code you are retreiving information for

 string

Required
apiToken

Your API Token

 string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Object

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "shortName": "sample string 2",
    "fullName": "sample string 3"
  },
  {
    "id": 1,
    "shortName": "sample string 2",
    "fullName": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<Cargoes xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Cargo>
    <ID>1</ID>
    <ShortName>sample string 2</ShortName>
    <FullName>sample string 3</FullName>
  </Cargo>
  <Cargo>
    <ID>1</ID>
    <ShortName>sample string 2</ShortName>
    <FullName>sample string 3</FullName>
  </Cargo>
</Cargoes>