Sustainability Service
(getCorruptPortCalls)
GetCorruptPortCalls retrieves lists of all port calls inside corrupt ports.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetCorruptPortCallsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"visits" : [ {
"countryCode" : "countryCode",
"numberOfPortCalls" : 0
}, {
"countryCode" : "countryCode",
"numberOfPortCalls" : 0
} ]
}
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. v3GetCorruptPortCallsResponse
default
An unexpected error response. rpcStatus
get /v3/sustainability/marine-protected-area-stays
(getMarineProtectedAreaStays)
GetMarineProtectedAreaStats retrieves lists of all stays inside marine protected areas for a single vessel.
Query parameters
imo (optional)
Query Parameter — format: int32
startDate (optional)
Query Parameter —
endDate (optional)
Query Parameter —
format (optional)
Query Parameter —
Return type
v3GetMarineProtectedAreaStaysResponse
Example data
Content-Type: application/json
{
"file" : "file",
"mpaStays" : [ {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
}, {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
} ]
}
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. v3GetMarineProtectedAreaStaysResponse
default
An unexpected error response. rpcStatus
post /v3/sustainability/marine-protected-area-summary
(getMarineProtectedAreaSummary)
GetMarineProtectedAreaStats retrieves lists of all stays inside marine protected areas.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetMarineProtectedAreaSummaryRequest (required)
Body Parameter —
Return type
v3GetMarineProtectedAreaSummaryResponse
Example data
Content-Type: application/json
{
"file" : "file",
"summaryRows" : [ {
"totalDurationDays" : 6.027456183070403,
"endDate" : "endDate",
"totalDistanceTraveledNm" : 5.637376656633329,
"imo" : 0,
"startDate" : "startDate",
"totalDurationHours" : 1.4658129805029452,
"vesselName" : "vesselName",
"avgSpeed" : 5.962133916683182
}, {
"totalDurationDays" : 6.027456183070403,
"endDate" : "endDate",
"totalDistanceTraveledNm" : 5.637376656633329,
"imo" : 0,
"startDate" : "startDate",
"totalDurationHours" : 1.4658129805029452,
"vesselName" : "vesselName",
"avgSpeed" : 5.962133916683182
} ],
"mpaStays" : [ {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
}, {
"durationDays" : 1.4658129805029452,
"durationHours" : 5.962133916683182,
"distanceTraveledNm" : 2.3021358869347655,
"exitedAt" : "exitedAt",
"countryCode" : "countryCode",
"mpaName" : "mpaName",
"enteredAt" : "enteredAt",
"imo" : 6,
"mpaId" : 0,
"vesselName" : "vesselName",
"avgSpeed" : 5.637376656633329
} ]
}
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. v3GetMarineProtectedAreaSummaryResponse
default
An unexpected error response. rpcStatus