POST api/PortExpectedArrivals

Returns any records matching the search criteria provided.

Request Information

URI Parameters

None.

Body Parameters

PortExpectedArrivalsPostParameters
NameDescriptionTypeAdditional information
PortGuid

MariData's unique identifier for the port.

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "PortGuid": "6f595c6a-d878-4ad3-b751-941672241a69"
}

application/xml, text/xml

Sample:
<PortExpectedArrivalsPostParameters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PortGuid>6f595c6a-d878-4ad3-b751-941672241a69</PortGuid>
</PortExpectedArrivalsPostParameters>

Response Information

Resource Description

Collection of VesselDestination
NameDescriptionTypeAdditional information
DestinationETA

The ETA of the vessel. UTC.

date

None.

DestinationPort

The destination port.

Port

None.

DistanceToDestination

The distance from the vessel's position to the port (nm).

decimal number

None.

PriorityOrder

The confidence in the result. A PriorityOrder of 1 is the most confident destination. A priority order of 2 is the next most confident destination...etc. Typically, only PriorityOrders of 1 are returned.

integer

None.

Vessel

The vessel.

Vessel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DestinationETA": "2019-11-15T04:33:53.3697334+00:00",
    "DestinationPort": {
      "Guid": "52cbe993-505d-4a1f-ac35-4a24c9cd35bf",
      "Name": "sample string 2",
      "Locode": "sample string 3",
      "WpiNumber": "sample string 4",
      "Country": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      }
    },
    "DistanceToDestination": 1.0,
    "PriorityOrder": 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
    }
  },
  {
    "DestinationETA": "2019-11-15T04:33:53.3697334+00:00",
    "DestinationPort": {
      "Guid": "52cbe993-505d-4a1f-ac35-4a24c9cd35bf",
      "Name": "sample string 2",
      "Locode": "sample string 3",
      "WpiNumber": "sample string 4",
      "Country": {
        "Name": "sample string 1",
        "Alpha2code": "sample string 2"
      }
    },
    "DistanceToDestination": 1.0,
    "PriorityOrder": 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
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfVesselDestination xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <VesselDestination>
    <DestinationETA>2019-11-15T04:33:53.3697334+00:00</DestinationETA>
    <DestinationPort>
      <Guid>52cbe993-505d-4a1f-ac35-4a24c9cd35bf</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>
    </DestinationPort>
    <DistanceToDestination>1</DistanceToDestination>
    <PriorityOrder>1</PriorityOrder>
    <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>
  </VesselDestination>
  <VesselDestination>
    <DestinationETA>2019-11-15T04:33:53.3697334+00:00</DestinationETA>
    <DestinationPort>
      <Guid>52cbe993-505d-4a1f-ac35-4a24c9cd35bf</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>
    </DestinationPort>
    <DistanceToDestination>1</DistanceToDestination>
    <PriorityOrder>1</PriorityOrder>
    <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>
  </VesselDestination>
</ArrayOfVesselDestination>