Skip to main content
Skip table of contents

Vessel Service

(getAisSummary)

Generates summary data regarding AIS received during a specific requested period for a single vessel

Consumes

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

application/json

Request body

body v3GetAisSummaryRequest (required)

Body Parameter —

Return type

v3GetAisSummaryResponse

Example data

Content-Type: application/json

{

"distanceTraveledNm" : 0.8008281904610115,

"initialTimestampForPeriod" : "2000-01-23T04:56:07.000+00:00",

"numberOfPositions" : 1,

"averageSpeedKnots" : 6.027456183070403,

"lastTimestampForPeriod" : "2000-01-23T04:56:07.000+00:00"

}

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. v3GetAisSummaryResponse

default

An unexpected error response. rpcStatus

Up

post /v3/vessels/stoppageevents

(listStoppageEvents)

Consumes

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

application/json

Request body

body v3ListStoppageEventsRequest (required)

Body Parameter —

Return type

v3ListStoppageEventsResponse

Example data

Content-Type: application/json

{

"xlsx" : "xlsx",

"csv" : "csv",

"stoppageEvents" : [ {

"durationHours" : 5.637376656633329,

"endedAt" : "endedAt",

"minSpeedObserved" : 5.962133916683182,

"startedAt" : "startedAt",

"zoneId" : 1,

"imo" : 0,

"lon" : 7.061401241503109,

"portName" : "portName",

"zoneName" : "zoneName",

"portId" : 6,

"classification" : "classification",

"lat" : 2.3021358869347655

}, {

"durationHours" : 5.637376656633329,

"endedAt" : "endedAt",

"minSpeedObserved" : 5.962133916683182,

"startedAt" : "startedAt",

"zoneId" : 1,

"imo" : 0,

"lon" : 7.061401241503109,

"portName" : "portName",

"zoneName" : "zoneName",

"portId" : 6,

"classification" : "classification",

"lat" : 2.3021358869347655

} ]

}

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. v3ListStoppageEventsResponse

default

An unexpected error response. rpcStatus

Up

post /v3/vessels/listvessels

(listVessels)

Vessels gets a list of vessels for the given filter parameters

Consumes

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

application/json

Request body

body v3ListVesselsRequest (required)

Body Parameter —

Return type

v3ListVesselsResponse

Example data

Content-Type: application/json

{

"xlsx" : "xlsx",

"csv" : "csv",

"vessels" : [ {

"lastPositionReceived" : "lastPositionReceived",

"dwt" : 1.4658129805029452,

"mmsi" : 6,

"berthId" : 7,

"subSegment" : "subSegment",

"destination" : "destination",

"destinationCountryCode" : "destinationCountryCode",

"imo" : 0,

"portName" : "portName",

"ladenStatus" : "ladenStatus",

"navigationalStatus" : 2,

"portId" : 5,

"berthName" : "berthName",

"speed" : 4.145608029883936,

"ladenStatusDraught" : "ladenStatusDraught",

"relatedPortName" : "relatedPortName",

"cargoStatus" : "cargoStatus",

"eta" : "eta",

"segment" : "segment",

"shipyardId" : 9,

"destinationPortName" : "destinationPortName",

"zoneId" : 5,

"zoneName" : "zoneName",

"relatedPortId" : 3,

"portCallStatus" : "portCallStatus",

"direction" : "direction",

"commodityGroup" : "commodityGroup",

"destinationRegion" : "destinationRegion",

"lastStaticReceived" : "lastStaticReceived",

"anchorageId" : 2,

"anchorageName" : "anchorageName",

"lastPortName" : "lastPortName",

"lastCountryCode" : "lastCountryCode",

"lastRegion" : "lastRegion",

"shipyardName" : "shipyardName",

"vesselName" : "vesselName",

"commodityName" : "commodityName"

}, {

"lastPositionReceived" : "lastPositionReceived",

"dwt" : 1.4658129805029452,

"mmsi" : 6,

"berthId" : 7,

"subSegment" : "subSegment",

"destination" : "destination",

"destinationCountryCode" : "destinationCountryCode",

"imo" : 0,

"portName" : "portName",

"ladenStatus" : "ladenStatus",

"navigationalStatus" : 2,

"portId" : 5,

"berthName" : "berthName",

"speed" : 4.145608029883936,

"ladenStatusDraught" : "ladenStatusDraught",

"relatedPortName" : "relatedPortName",

"cargoStatus" : "cargoStatus",

"eta" : "eta",

"segment" : "segment",

"shipyardId" : 9,

"destinationPortName" : "destinationPortName",

"zoneId" : 5,

"zoneName" : "zoneName",

"relatedPortId" : 3,

"portCallStatus" : "portCallStatus",

"direction" : "direction",

"commodityGroup" : "commodityGroup",

"destinationRegion" : "destinationRegion",

"lastStaticReceived" : "lastStaticReceived",

"anchorageId" : 2,

"anchorageName" : "anchorageName",

"lastPortName" : "lastPortName",

"lastCountryCode" : "lastCountryCode",

"lastRegion" : "lastRegion",

"shipyardName" : "shipyardName",

"vesselName" : "vesselName",

"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. v3ListVesselsResponse

default

An unexpected error response. rpcStatus

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.