Vessel State Service

(getVesselStates)

Returns historical vessel states for the given dates and imo numbers supplied.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body v3GetVesselStatesRequest (required)

Body Parameter —

Return type

v3VesselStatesResponse

Example data

Content-Type: application/json

{

"vesselStates" : [ {

"predictedDestinationPortId" : 7,

"predictedDestinationScore" : 1.2315135367772556,

"subSegment" : "subSegment",

"lastVisitedPortId" : 6,

"portId" : 5,

"destinationScore" : 4.145608029883936,

"lastVisitedPortName" : "lastVisitedPortName",

"berthName" : "berthName",

"ladenStatusDraught" : "ladenStatusDraught",

"relatedPortName" : "relatedPortName",

"eta" : "eta",

"segment" : "segment",

"destinationPortName" : "destinationPortName",

"zoneId" : 5,

"predictedDestinationPortName" : "predictedDestinationPortName",

"ladenStatusModel" : "ladenStatusModel",

"commodityGroup" : "commodityGroup",

"lastOpsPortName" : "lastOpsPortName",

"lastOpsPortId" : 7,

"anchorageName" : "anchorageName",

"shipyardName" : "shipyardName",

"vesselName" : "vesselName",

"dwt" : 1.4658129805029452,

"volumeOnBoard" : 1.1730742509559433,

"mmsi" : 6,

"destinationPortId" : 2,

"berthId" : 7,

"destination" : "destination",

"destinationCountryCode" : "destinationCountryCode",

"imo" : 0,

"vesselStatus" : "vesselStatus",

"portName" : "portName",

"navigationalStatus" : "navigationalStatus",

"speedStatus" : "speedStatus",

"predictedDestinationCountryCode" : "predictedDestinationCountryCode",

"shipyardId" : 9,

"zoneName" : "zoneName",

"relatedPortId" : 3,

"portCallStatus" : "portCallStatus",

"hoursCarriedForward" : 4,

"timestamp" : "timestamp",

"direction" : "direction",

"predictedDestinationRegion" : "predictedDestinationRegion",

"destinationRegion" : "destinationRegion",

"commodityId" : 1,

"anchorageId" : 2,

"vesselType" : "vesselType",

"navigationalStatusCode" : 1,

"commodityName" : "commodityName"

}, {

"predictedDestinationPortId" : 7,

"predictedDestinationScore" : 1.2315135367772556,

"subSegment" : "subSegment",

"lastVisitedPortId" : 6,

"portId" : 5,

"destinationScore" : 4.145608029883936,

"lastVisitedPortName" : "lastVisitedPortName",

"berthName" : "berthName",

"ladenStatusDraught" : "ladenStatusDraught",

"relatedPortName" : "relatedPortName",

"eta" : "eta",

"segment" : "segment",

"destinationPortName" : "destinationPortName",

"zoneId" : 5,

"predictedDestinationPortName" : "predictedDestinationPortName",

"ladenStatusModel" : "ladenStatusModel",

"commodityGroup" : "commodityGroup",

"lastOpsPortName" : "lastOpsPortName",

"lastOpsPortId" : 7,

"anchorageName" : "anchorageName",

"shipyardName" : "shipyardName",

"vesselName" : "vesselName",

"dwt" : 1.4658129805029452,

"volumeOnBoard" : 1.1730742509559433,

"mmsi" : 6,

"destinationPortId" : 2,

"berthId" : 7,

"destination" : "destination",

"destinationCountryCode" : "destinationCountryCode",

"imo" : 0,

"vesselStatus" : "vesselStatus",

"portName" : "portName",

"navigationalStatus" : "navigationalStatus",

"speedStatus" : "speedStatus",

"predictedDestinationCountryCode" : "predictedDestinationCountryCode",

"shipyardId" : 9,

"zoneName" : "zoneName",

"relatedPortId" : 3,

"portCallStatus" : "portCallStatus",

"hoursCarriedForward" : 4,

"timestamp" : "timestamp",

"direction" : "direction",

"predictedDestinationRegion" : "predictedDestinationRegion",

"destinationRegion" : "destinationRegion",

"commodityId" : 1,

"anchorageId" : 2,

"vesselType" : "vesselType",

"navigationalStatusCode" : 1,

"commodityName" : "commodityName"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

A successful response. v3VesselStatesResponse

default

An unexpected error response. rpcStatus

Up

post /v3/vessel-states-for-date

(getVesselStatesForDate)

Returns all historical states for the entire fleet for a single date.

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body v3GetVesselStatesForDateRequest (required)

Body Parameter —

Return type

v3VesselStatesResponse

Example data

Content-Type: application/json

{

"vesselStates" : [ {

"predictedDestinationPortId" : 7,

"predictedDestinationScore" : 1.2315135367772556,

"subSegment" : "subSegment",

"lastVisitedPortId" : 6,

"portId" : 5,

"destinationScore" : 4.145608029883936,

"lastVisitedPortName" : "lastVisitedPortName",

"berthName" : "berthName",

"ladenStatusDraught" : "ladenStatusDraught",

"relatedPortName" : "relatedPortName",

"eta" : "eta",

"segment" : "segment",

"destinationPortName" : "destinationPortName",

"zoneId" : 5,

"predictedDestinationPortName" : "predictedDestinationPortName",

"ladenStatusModel" : "ladenStatusModel",

"commodityGroup" : "commodityGroup",

"lastOpsPortName" : "lastOpsPortName",

"lastOpsPortId" : 7,

"anchorageName" : "anchorageName",

"shipyardName" : "shipyardName",

"vesselName" : "vesselName",

"dwt" : 1.4658129805029452,

"volumeOnBoard" : 1.1730742509559433,

"mmsi" : 6,

"destinationPortId" : 2,

"berthId" : 7,

"destination" : "destination",

"destinationCountryCode" : "destinationCountryCode",

"imo" : 0,

"vesselStatus" : "vesselStatus",

"portName" : "portName",

"navigationalStatus" : "navigationalStatus",

"speedStatus" : "speedStatus",

"predictedDestinationCountryCode" : "predictedDestinationCountryCode",

"shipyardId" : 9,

"zoneName" : "zoneName",

"relatedPortId" : 3,

"portCallStatus" : "portCallStatus",

"hoursCarriedForward" : 4,

"timestamp" : "timestamp",

"direction" : "direction",

"predictedDestinationRegion" : "predictedDestinationRegion",

"destinationRegion" : "destinationRegion",

"commodityId" : 1,

"anchorageId" : 2,

"vesselType" : "vesselType",

"navigationalStatusCode" : 1,

"commodityName" : "commodityName"

}, {

"predictedDestinationPortId" : 7,

"predictedDestinationScore" : 1.2315135367772556,

"subSegment" : "subSegment",

"lastVisitedPortId" : 6,

"portId" : 5,

"destinationScore" : 4.145608029883936,

"lastVisitedPortName" : "lastVisitedPortName",

"berthName" : "berthName",

"ladenStatusDraught" : "ladenStatusDraught",

"relatedPortName" : "relatedPortName",

"eta" : "eta",

"segment" : "segment",

"destinationPortName" : "destinationPortName",

"zoneId" : 5,

"predictedDestinationPortName" : "predictedDestinationPortName",

"ladenStatusModel" : "ladenStatusModel",

"commodityGroup" : "commodityGroup",

"lastOpsPortName" : "lastOpsPortName",

"lastOpsPortId" : 7,

"anchorageName" : "anchorageName",

"shipyardName" : "shipyardName",

"vesselName" : "vesselName",

"dwt" : 1.4658129805029452,

"volumeOnBoard" : 1.1730742509559433,

"mmsi" : 6,

"destinationPortId" : 2,

"berthId" : 7,

"destination" : "destination",

"destinationCountryCode" : "destinationCountryCode",

"imo" : 0,

"vesselStatus" : "vesselStatus",

"portName" : "portName",

"navigationalStatus" : "navigationalStatus",

"speedStatus" : "speedStatus",

"predictedDestinationCountryCode" : "predictedDestinationCountryCode",

"shipyardId" : 9,

"zoneName" : "zoneName",

"relatedPortId" : 3,

"portCallStatus" : "portCallStatus",

"hoursCarriedForward" : 4,

"timestamp" : "timestamp",

"direction" : "direction",

"predictedDestinationRegion" : "predictedDestinationRegion",

"destinationRegion" : "destinationRegion",

"commodityId" : 1,

"anchorageId" : 2,

"vesselType" : "vesselType",

"navigationalStatusCode" : 1,

"commodityName" : "commodityName"

} ]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

A successful response. v3VesselStatesResponse

default

An unexpected error response. rpcStatus