GET v1/vessels/{companyCode}/{vesselCode}?apiToken={apiToken}

Returns information about a specific vessel from the provided company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company the vessel is associated with	string	Required
vesselCode	The vessel code of the vessel	string	Required
apiToken	Your API token	string	None.

Body Parameters

None.

Response Information

Resource Description

VesselResponse

Name	Type	Additional information
VesselCode	string	None.
VesselName	string	None.
CompanyCode	string	None.
IMONumber	string	None.
DWT	decimal number	None.
VesselTypeCode	string	None.
VesselType	string	None.
CallSign	string	None.
Email	string	None.

Response Formats

application/json, text/json

Sample:

{
  "vesselCode": "sample string 1",
  "vesselName": "sample string 2",
  "companyCode": "sample string 3",
  "imoNumber": "sample string 4",
  "dwt": 5.1,
  "vesselTypeCode": "sample string 6",
  "vesselType": "sample string 7",
  "callSign": "sample string 8",
  "email": "sample string 9"
}

application/xml, text/xml

Sample:

<Vessel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VesselCode>sample string 1</VesselCode>
  <VesselName>sample string 2</VesselName>
  <CompanyCode>sample string 3</CompanyCode>
  <IMONumber>sample string 4</IMONumber>
  <DWT>5.1</DWT>
  <VesselTypeCode>sample string 6</VesselTypeCode>
  <VesselType>sample string 7</VesselType>
  <CallSign>sample string 8</CallSign>
  <Email>sample string 9</Email>
</Vessel>