(getPolygonCounts)
GetPolygonCounts returns vessels counts (points) in polygon the given filter parameters
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3CustomPolygonRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"timeseries" : [ {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
}, {
"rows" : [ {
"date" : "date",
"value" : 0.8008281904610115
}, {
"date" : "date",
"value" : 0.8008281904610115
} ],
"group" : "group"
} ]
}
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. v3CustomPolygonResponse
default
An unexpected error response. rpcStatus
DistanceCalculatorService
post /v3/batch-calculate-distance
(batchCalculateDistance)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3BatchDistanceRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"responses" : [ {
"individualLegs" : [ {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
}, {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
} ],
"totalShortestPath" : [ {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
}, {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
} ],
"totalDistance" : 0.8008281904610115,
"totalDurationHours" : 6.027456183070403,
"status" : "ERROR"
}, {
"individualLegs" : [ {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
}, {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
} ],
"totalShortestPath" : [ {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
}, {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
} ],
"totalDistance" : 0.8008281904610115,
"totalDurationHours" : 6.027456183070403,
"status" : "ERROR"
} ]
}
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. v3BatchDistanceResponse
default
An unexpected error response. rpcStatus
post /v3/calculate-distance
(calculateDistance)
Calculates distances for the shortest route between a two or more locations. Distances are returned both for the voyage as a whole, and individually for each leg of the voyage. Endpoint also returns the shortest route as a series of points. If speed is specified, expected duration of the voyage will also be returned.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3DistanceRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"individualLegs" : [ {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
}, {
"durationHours" : 2.3021358869347655,
"distance" : 5.637376656633329,
"shortestPath" : [ null, null ],
"startingPointModified" : true
} ],
"totalShortestPath" : [ {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
}, {
"lon" : 1.4658129805029452,
"lat" : 5.962133916683182
} ],
"totalDistance" : 0.8008281904610115,
"totalDurationHours" : 6.027456183070403,
"status" : "ERROR"
}
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. v3DistanceResponse
default
An unexpected error response. rpcStatus