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

Returns a list of all ports in the system for the specified company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company you want to receive port information for	string	Required
apiToken	Your API token	string	None.

Body Parameters

None.

Response Information

Resource Description

A list of port information

Collection of Object

None.

Response Formats

application/json, text/json

Sample:

[
  {
    "portNo": 1,
    "name": "sample string 2",
    "country": "sample string 3",
    "unCode": "sample string 4",
    "latitude": 5.1,
    "longitude": 6.1
  },
  {
    "portNo": 1,
    "name": "sample string 2",
    "country": "sample string 3",
    "unCode": "sample string 4",
    "latitude": 5.1,
    "longitude": 6.1
  }
]

application/xml, text/xml

Sample:

<Ports xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Port>
    <PortNo>1</PortNo>
    <Name>sample string 2</Name>
    <Country>sample string 3</Country>
    <UNCode>sample string 4</UNCode>
    <Latitude>5.1</Latitude>
    <Longitude>6.1</Longitude>
  </Port>
  <Port>
    <PortNo>1</PortNo>
    <Name>sample string 2</Name>
    <Country>sample string 3</Country>
    <UNCode>sample string 4</UNCode>
    <Latitude>5.1</Latitude>
    <Longitude>6.1</Longitude>
  </Port>
</Ports>