POST api/VesselMovements

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

VesselMovementsPostParameters
NameDescriptionTypeAdditional information
StartCountryAlpha2Code

The ISO 2 character country code for the start country(s).

Collection of string

Max length: 2

Min length: 2

EndCountryAlpha2Code

The ISO 2 character country code for the end country(s).

Collection of string

Max length: 2

Min length: 2

StartPortGuid

The Guid of the start port(s).

Collection of globally unique identifier

Max length: 36

Min length: 36

EndPortGuid

The Guid of the end port(s).

Collection of globally unique identifier

Max length: 36

Min length: 36

StartBerthGuid

The Guid of the start berth(s).

Collection of globally unique identifier

Max length: 36

Min length: 36

EndBerthGuid

The Guid of the end berth(s).

Collection of globally unique identifier

Max length: 36

Min length: 36

StartDepartureDateStartYYYYMMDD

The start date of the search for the departure from the start port. UTC. YYYYMMDD.

string

Max length: 8

Min length: 8

StartDepartureDateEndYYYYMMDD

The end date of the search for the departure from the start port. UTC. YYYYMMDD.

string

Max length: 8

Min length: 8

EndArrivalDateStartYYYYMMDD

The start date of the search for the arrival at the end port. UTC. YYYYMMDD.

string

Max length: 8

Min length: 8

EndArrivalDateEndYYYYMMDD

The end date of the search for the arrival at the end port. UTC. YYYYMMDD.

string

Max length: 8

Min length: 8

VesselIMO

The IMO number of a specific vessel

Collection of string

Max length: 7

Min length: 7

VesselType

The type of vessel

Collection of string

Max length: 255

DWTLow

The lowest DWT to search

integer

Range: inclusive between 0 and 1000000

DWTHigh

The highest DWT to search

integer

Range: inclusive between 0 and 1000000

LoadPercentLow

The lowest load as a percentage of maximum draught on arrival at the end location

integer

Range: inclusive between 0 and 100

LoadPercentHigh

The highest load as a percentage of maximum draught on arrival at the end location

integer

Range: inclusive between 0 and 100

HideSameCountry

Exclude movements where the start country is equal to the end country (i.e. the vessel never left the start country). Defaults to true.

boolean

None.

HideSamePort

Exclude movements where the start port is equal to the end country (i.e. the vessel returned to the same port). Defaults to true.

boolean

None.

ShowLadenDeparture

Show vessels that have left the start port laden. Defaults to true.

boolean

None.

ShowBallastDeparture

Show vessels that have left the start port ballast. Defaults to true.

boolean

None.

ShowWaitingInPort

Shows vessels that are still in the start port(s) or start berth(s) (if those start locations are provided). Defaults to false.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "StartCountryAlpha2Code": [
    "sample string 1",
    "sample string 2"
  ],
  "EndCountryAlpha2Code": [
    "sample string 1",
    "sample string 2"
  ],
  "StartPortGuid": [
    "9494055a-6ba7-4c25-81e6-a40d61d874ff",
    "3d0f49d9-e855-4eb9-bcf9-0089a12d6e36"
  ],
  "EndPortGuid": [
    "4eaa5ee9-2c44-4d1c-a2ba-6030a6c95505",
    "cb1aa312-87da-418d-b3e8-4c62f36910fc"
  ],
  "StartBerthGuid": [
    "a20ac9b5-e610-4cb0-b2d4-cc5bdb839ea8",
    "77bdeee8-ff13-4675-9d69-4467e694b110"
  ],
  "EndBerthGuid": [
    "3299a6e2-3307-4579-81e4-385c942da338",
    "086a38a1-b03e-468c-b3cb-fdec487b3878"
  ],
  "StartDepartureDateStartYYYYMMDD": "sample string 1",
  "StartDepartureDateEndYYYYMMDD": "sample string 2",
  "EndArrivalDateStartYYYYMMDD": "sample string 3",
  "EndArrivalDateEndYYYYMMDD": "sample string 4",
  "VesselIMO": [
    "sample string 1",
    "sample string 2"
  ],
  "VesselType": [
    "sample string 1",
    "sample string 2"
  ],
  "DWTLow": 1,
  "DWTHigh": 1,
  "LoadPercentLow": 1,
  "LoadPercentHigh": 1,
  "HideSameCountry": true,
  "HideSamePort": true,
  "ShowLadenDeparture": true,
  "ShowBallastDeparture": true,
  "ShowWaitingInPort": true
}

application/xml, text/xml

Sample:
<VesselMovementsPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StartCountryAlpha2Code>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </StartCountryAlpha2Code>
  <EndCountryAlpha2Code>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </EndCountryAlpha2Code>
  <StartPortGuid>
    <guid>9494055a-6ba7-4c25-81e6-a40d61d874ff</guid>
    <guid>3d0f49d9-e855-4eb9-bcf9-0089a12d6e36</guid>
  </StartPortGuid>
  <EndPortGuid>
    <guid>4eaa5ee9-2c44-4d1c-a2ba-6030a6c95505</guid>
    <guid>cb1aa312-87da-418d-b3e8-4c62f36910fc</guid>
  </EndPortGuid>
  <StartBerthGuid>
    <guid>a20ac9b5-e610-4cb0-b2d4-cc5bdb839ea8</guid>
    <guid>77bdeee8-ff13-4675-9d69-4467e694b110</guid>
  </StartBerthGuid>
  <EndBerthGuid>
    <guid>3299a6e2-3307-4579-81e4-385c942da338</guid>
    <guid>086a38a1-b03e-468c-b3cb-fdec487b3878</guid>
  </EndBerthGuid>
  <StartDepartureDateStartYYYYMMDD>sample string 1</StartDepartureDateStartYYYYMMDD>
  <StartDepartureDateEndYYYYMMDD>sample string 2</StartDepartureDateEndYYYYMMDD>
  <EndArrivalDateStartYYYYMMDD>sample string 3</EndArrivalDateStartYYYYMMDD>
  <EndArrivalDateEndYYYYMMDD>sample string 4</EndArrivalDateEndYYYYMMDD>
  <VesselIMO>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </VesselIMO>
  <VesselType>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </VesselType>
  <DWTLow>1</DWTLow>
  <DWTHigh>1</DWTHigh>
  <LoadPercentLow>1</LoadPercentLow>
  <LoadPercentHigh>1</LoadPercentHigh>
  <HideSameCountry>true</HideSameCountry>
  <HideSamePort>true</HideSamePort>
  <ShowLadenDeparture>true</ShowLadenDeparture>
  <ShowBallastDeparture>true</ShowBallastDeparture>
  <ShowWaitingInPort>true</ShowWaitingInPort>
</VesselMovementsPostParameters>

Response Information

Resource Description

Collection of VesselMovement
NameDescriptionTypeAdditional information
Vessel

The vessel

Vessel

None.

StartLocation

The start location

PortArea

None.

StartLocationArrivalTime

The date / time that the vessel arrived in the StartLocation

date

None.

StartLocationDepartureTime

The date / time that the vessel departed the StartLocation

date

None.

EndLocation

The end location

PortArea

None.

EndLocationArrivalTime

The date / time that the vessel arrived in the EndLocation

date

None.

EndLocationDepartureTime

The date / time that the vessel departed the EndLocation

date

None.

PercentLoadedOnArrival

The load as a percentage of maximum draught on arrival at the end location

integer

None.

Commodity

The commodity / cargo that the vessel may have been carrying if it was loaded.

Commodity

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Vessel": {
      "Name": "sample string 1",
      "IMO": "sample string 2",
      "MMSI": "sample string 3",
      "CallSign": "sample string 4",
      "Flag": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      },
      "Type": "sample string 5",
      "Dwt": 1,
      "Length": 1.0,
      "Breadth": 1.0
    },
    "StartLocation": {
      "Guid": "2b6a6398-7be4-48c4-bd2e-cdac2773c440",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Terminal": "sample string 4",
      "Port": {
        "Guid": "4128b4c8-f887-4884-9d52-1b02f1f980c1",
        "Name": "sample string 2",
        "Locode": "sample string 3",
        "WpiNumber": "sample string 4",
        "Country": {
          "Name": "sample string 1",
          "Alpha2code": "sample string 2"
        }
      }
    },
    "StartLocationArrivalTime": "2019-11-15T04:49:56.4812498+00:00",
    "StartLocationDepartureTime": "2019-11-15T04:49:56.4812498+00:00",
    "EndLocation": {
      "Guid": "2b6a6398-7be4-48c4-bd2e-cdac2773c440",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Terminal": "sample string 4",
      "Port": {
        "Guid": "4128b4c8-f887-4884-9d52-1b02f1f980c1",
        "Name": "sample string 2",
        "Locode": "sample string 3",
        "WpiNumber": "sample string 4",
        "Country": {
          "Name": "sample string 1",
          "Alpha2code": "sample string 2"
        }
      }
    },
    "EndLocationArrivalTime": "2019-11-15T04:49:56.4812498+00:00",
    "EndLocationDepartureTime": "2019-11-15T04:49:56.4812498+00:00",
    "PercentLoadedOnArrival": 1,
    "Commodity": {
      "Name": "sample string 1",
      "Tonnage": 1
    }
  },
  {
    "Vessel": {
      "Name": "sample string 1",
      "IMO": "sample string 2",
      "MMSI": "sample string 3",
      "CallSign": "sample string 4",
      "Flag": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      },
      "Type": "sample string 5",
      "Dwt": 1,
      "Length": 1.0,
      "Breadth": 1.0
    },
    "StartLocation": {
      "Guid": "2b6a6398-7be4-48c4-bd2e-cdac2773c440",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Terminal": "sample string 4",
      "Port": {
        "Guid": "4128b4c8-f887-4884-9d52-1b02f1f980c1",
        "Name": "sample string 2",
        "Locode": "sample string 3",
        "WpiNumber": "sample string 4",
        "Country": {
          "Name": "sample string 1",
          "Alpha2code": "sample string 2"
        }
      }
    },
    "StartLocationArrivalTime": "2019-11-15T04:49:56.4812498+00:00",
    "StartLocationDepartureTime": "2019-11-15T04:49:56.4812498+00:00",
    "EndLocation": {
      "Guid": "2b6a6398-7be4-48c4-bd2e-cdac2773c440",
      "Name": "sample string 2",
      "Type": "sample string 3",
      "Terminal": "sample string 4",
      "Port": {
        "Guid": "4128b4c8-f887-4884-9d52-1b02f1f980c1",
        "Name": "sample string 2",
        "Locode": "sample string 3",
        "WpiNumber": "sample string 4",
        "Country": {
          "Name": "sample string 1",
          "Alpha2code": "sample string 2"
        }
      }
    },
    "EndLocationArrivalTime": "2019-11-15T04:49:56.4812498+00:00",
    "EndLocationDepartureTime": "2019-11-15T04:49:56.4812498+00:00",
    "PercentLoadedOnArrival": 1,
    "Commodity": {
      "Name": "sample string 1",
      "Tonnage": 1
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfVesselMovement xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VesselMovement>
    <Vessel>
      <Name>sample string 1</Name>
      <IMO>sample string 2</IMO>
      <MMSI>sample string 3</MMSI>
      <CallSign>sample string 4</CallSign>
      <Flag>
        <Name>sample string 1</Name>
        <Alpha2code>sample string 2</Alpha2code>
      </Flag>
      <Type>sample string 5</Type>
      <Dwt>1</Dwt>
      <Length>1</Length>
      <Breadth>1</Breadth>
    </Vessel>
    <StartLocation>
      <Guid>2b6a6398-7be4-48c4-bd2e-cdac2773c440</Guid>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
      <Terminal>sample string 4</Terminal>
      <Port>
        <Guid>4128b4c8-f887-4884-9d52-1b02f1f980c1</Guid>
        <Name>sample string 2</Name>
        <Locode>sample string 3</Locode>
        <WpiNumber>sample string 4</WpiNumber>
        <Country>
          <Name>sample string 1</Name>
          <Alpha2code>sample string 2</Alpha2code>
        </Country>
      </Port>
    </StartLocation>
    <StartLocationArrivalTime>2019-11-15T04:49:56.4812498+00:00</StartLocationArrivalTime>
    <StartLocationDepartureTime>2019-11-15T04:49:56.4812498+00:00</StartLocationDepartureTime>
    <EndLocation>
      <Guid>2b6a6398-7be4-48c4-bd2e-cdac2773c440</Guid>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
      <Terminal>sample string 4</Terminal>
      <Port>
        <Guid>4128b4c8-f887-4884-9d52-1b02f1f980c1</Guid>
        <Name>sample string 2</Name>
        <Locode>sample string 3</Locode>
        <WpiNumber>sample string 4</WpiNumber>
        <Country>
          <Name>sample string 1</Name>
          <Alpha2code>sample string 2</Alpha2code>
        </Country>
      </Port>
    </EndLocation>
    <EndLocationArrivalTime>2019-11-15T04:49:56.4812498+00:00</EndLocationArrivalTime>
    <EndLocationDepartureTime>2019-11-15T04:49:56.4812498+00:00</EndLocationDepartureTime>
    <PercentLoadedOnArrival>1</PercentLoadedOnArrival>
    <Commodity>
      <Name>sample string 1</Name>
      <Tonnage>1</Tonnage>
    </Commodity>
  </VesselMovement>
  <VesselMovement>
    <Vessel>
      <Name>sample string 1</Name>
      <IMO>sample string 2</IMO>
      <MMSI>sample string 3</MMSI>
      <CallSign>sample string 4</CallSign>
      <Flag>
        <Name>sample string 1</Name>
        <Alpha2code>sample string 2</Alpha2code>
      </Flag>
      <Type>sample string 5</Type>
      <Dwt>1</Dwt>
      <Length>1</Length>
      <Breadth>1</Breadth>
    </Vessel>
    <StartLocation>
      <Guid>2b6a6398-7be4-48c4-bd2e-cdac2773c440</Guid>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
      <Terminal>sample string 4</Terminal>
      <Port>
        <Guid>4128b4c8-f887-4884-9d52-1b02f1f980c1</Guid>
        <Name>sample string 2</Name>
        <Locode>sample string 3</Locode>
        <WpiNumber>sample string 4</WpiNumber>
        <Country>
          <Name>sample string 1</Name>
          <Alpha2code>sample string 2</Alpha2code>
        </Country>
      </Port>
    </StartLocation>
    <StartLocationArrivalTime>2019-11-15T04:49:56.4812498+00:00</StartLocationArrivalTime>
    <StartLocationDepartureTime>2019-11-15T04:49:56.4812498+00:00</StartLocationDepartureTime>
    <EndLocation>
      <Guid>2b6a6398-7be4-48c4-bd2e-cdac2773c440</Guid>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
      <Terminal>sample string 4</Terminal>
      <Port>
        <Guid>4128b4c8-f887-4884-9d52-1b02f1f980c1</Guid>
        <Name>sample string 2</Name>
        <Locode>sample string 3</Locode>
        <WpiNumber>sample string 4</WpiNumber>
        <Country>
          <Name>sample string 1</Name>
          <Alpha2code>sample string 2</Alpha2code>
        </Country>
      </Port>
    </EndLocation>
    <EndLocationArrivalTime>2019-11-15T04:49:56.4812498+00:00</EndLocationArrivalTime>
    <EndLocationDepartureTime>2019-11-15T04:49:56.4812498+00:00</EndLocationDepartureTime>
    <PercentLoadedOnArrival>1</PercentLoadedOnArrival>
    <Commodity>
      <Name>sample string 1</Name>
      <Tonnage>1</Tonnage>
    </Commodity>
  </VesselMovement>
</ArrayOfVesselMovement>