GET v1/vessels/{companyCode}?apiToken={apiToken}&activeOnly={activeOnly}

Returns a list of all vessels available in a specific company

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	The company you want to get the vessels for	string	Required
apiToken	Your API token	string	None.
activeOnly	Set to true to only show active vessels	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of Object

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"
  },
  {
    "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:

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