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

Returns a single port with the specified port number in the provided company's system

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

The company you want to retrieve the port from

 string

Required
portNo

The port number of the port

 integer

Required
apiToken

Your API Token

 string

None.

Body Parameters

None.

Response Information

Resource Description

PortResponse
NameDescriptionTypeAdditional information
PortNo

integer

None.
Name

string

None.
Country

string

None.
UNCode

string

None.
Latitude

decimal number

None.
Longitude

decimal number

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
}

application/xml, text/xml

Sample: 
<Port xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>