post /v3/livestates/aisquality
(aisQuality)
AisQuality returns the overview of how many positions reseived for vessels in different time periods
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3LiveStateRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"vesselSegmentsByTime" : [ {
"data" : [ {
"count" : 1,
"from" : 0,
"to" : 6
}, {
"count" : 1,
"from" : 0,
"to" : 6
} ],
"subSegment" : "subSegment"
}, {
"data" : [ {
"count" : 1,
"from" : 0,
"to" : 6
}, {
"count" : 1,
"from" : 0,
"to" : 6
} ],
"subSegment" : "subSegment"
} ],
"zonesBySegment" : [ {
"data" : [ {
"subSegment" : "subSegment",
"count" : 5
}, {
"subSegment" : "subSegment",
"count" : 5
} ],
"zoneName" : "zoneName"
}, {
"data" : [ {
"subSegment" : "subSegment",
"count" : 5
}, {
"subSegment" : "subSegment",
"count" : 5
} ],
"zoneName" : "zoneName"
} ],
"zonesByTime" : [ {
"data" : [ null, null ],
"zoneName" : "zoneName"
}, {
"data" : [ null, null ],
"zoneName" : "zoneName"
} ]
}
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. v3AisQualityResponse
default
An unexpected error response. rpcStatus
post /v3/livestates/vessels
(vessels)
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 v3LiveStateRequest (required)
Body Parameter —
Return type
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. v3VesselsResponse
default
An unexpected error response. rpcStatus
post /v3/livestates/inarea
(vesselsInArea)
VesselsInArea gets vessels as geo objects in rectangular area 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 v3LiveStateRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"vesselsReturned" : 6,
"vesselsTotal" : 0,
"vesselsInView" : 1,
"vessels" : [ {
"mmsi" : 5,
"geomCoordinates" : "geomCoordinates",
"course" : 2.3021358869347655,
"imo" : 5,
"ladenStatus" : "ladenStatus",
"speed" : 7.061401241503109,
"vesselName" : "vesselName"
}, {
"mmsi" : 5,
"geomCoordinates" : "geomCoordinates",
"course" : 2.3021358869347655,
"imo" : 5,
"ladenStatus" : "ladenStatus",
"speed" : 7.061401241503109,
"vesselName" : "vesselName"
} ]
}
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. v3VesselsInAreaResponse
default
An unexpected error response. rpcStatus
PolygonManagementService
post /v3/layers/{layerId}/polygons
(addPolygon)
AddPolygon adds new vessel to user's layer
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3PolygonParams (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}
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. v3Polygon1
default
An unexpected error response. rpcStatus
post /v3/layers/{layerId}/batch-add-polygons
(batchAddPolygons)
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body layerId_batchaddpolygons_body (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
post /v3/layers
(createLayer)
CreateLayer creates new layer for the current user
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3CreateLayerRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
delete /v3/layers/{layerId}
(deleteLayer)
DeleteLayer deletes layer for the current user
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
delete /v3/layers/{layerId}/polygons/{polygonId}
(deletePolygon)
DeletePolygon removes vessel from user's layer
Path parameters
layerId (required)
Path Parameter —
polygonId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
get /v3/layers/{layerId}
(describeLayer)
GetLayer gets fleed by layer id for the current user
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
delete /v3/layers/{layerId}/drop-polygons
(dropPolygons)
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
get /v3/layers
(listLayers)
ListLayers lists layers for the current user
Return type
Example data
Content-Type: application/json
{
"layers" : [ {
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}, {
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
} ],
"predefinedLayers" : [ null, null ]
}
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. v3Layers
default
An unexpected error response. rpcStatus
get /v3/layers/{layerId}/polygons
(listPolygons)
GetLayerPolygons gets layer polygons for the current user
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"polygonsInLayer" : 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. v3Polygons
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/rename-layer
(renameLayer)
RenameLayer changes the name of the layer for the current user
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body layerId_renamelayer_body (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
post /v3/layers/{layerId}/replace-polygons
(replacePolygons)
Path parameters
layerId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body layerId_replacepolygons_body (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{ }
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. v3EmptyResponse1
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/share-layer
(shareLayer)
Sets the shared status of the layer to be either shared/not shared
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/unshare-layer
(unshareLayer)
Sets the shared status of the layer to be either shared/not shared
Path parameters
layerId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"layerId" : "layerId",
"polygons" : [ {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}, {
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
} ],
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"polygonsInLayer" : 0,
"layerName" : "layerName",
"sharedWithOrg" : true
}
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. v3Layer
default
An unexpected error response. rpcStatus
put /v3/layers/{layerId}/polygons/{polygonId}
(updatePolygon)
UpdatePolygon updates existing vessel to user's layer
Path parameters
layerId (required)
Path Parameter —
polygonId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3PolygonParams (required)
Body Parameter —
Query parameters
upsert (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"layerId" : "layerId",
"polygonName" : "polygonName",
"polygonId" : "polygonId"
}
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. v3Polygon1
default
An unexpected error response. rpcStatus