post /v3/fleets/{fleetId}/vessels
(addVessel)
Adds new vessel to a Fleet. A maximum of 1000 vessels can be added to a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be added.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for adding a Vessel to a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}
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. v3Vessel1
default
An unexpected error response. rpcStatus
post /v3/fleets/{fleetId}/batch-add-vessels
(batchAddVessels)
Batch adds vessels into a Fleet. A maximum of 1000 vessels can be added to a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be added.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for batch adding Vessels to a Fleet (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. v3EmptyResponse
default
An unexpected error response. rpcStatus
post /v3/fleets
(createFleet)
Creates a new Fleet for the current user.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3CreateFleetRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"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. v3Fleet
default
An unexpected error response. rpcStatus
delete /v3/fleets/{fleetId}
(deleteFleet)
Deletes a Fleet for the current user.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be deleted.
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
delete /v3/fleets/{fleetId}/vessels/{imo}
(deleteVessel)
Removes a vessel from a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where the vessel should be deleted.
imo (required)
Path Parameter — IMO number of the Vessel to be deleted. format: int32
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
get /v3/fleets/{fleetId}
(describeFleet)
Retrieves fleet by Fleet id.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be retrieved.
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"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. v3Fleet
default
An unexpected error response. rpcStatus
delete /v3/fleets/{fleetId}/drop-vessels
(dropVessels)
Drops all the vessels currently in a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be dropped.
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. v3EmptyResponse
default
An unexpected error response. rpcStatus
get /v3/fleets/livemap
(getFleetLiveMap)
GetFleetLiveMap display static location for vessels in a fleet (as static image).
Query parameters
fleetId (optional)
Query Parameter — Identifier of the Fleet resource.
mapTheme (optional)
Query Parameter — Specifies the map theme. Allowed values are: [light-v10, dark-v10, navigation-night-v1, navigation-day-v1, outdoors-v11, satellite-v9].
Return type
Example data
Content-Type: application/json
{
"mapImage" : "mapImage"
}
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. v3GetFleetLiveMapResponse
default
An unexpected error response. rpcStatus
get /v3/fleets
(listFleets)
Lists Fleets for the current user (or fleets that are shared with the current user)
Return type
Example data
Content-Type: application/json
{
"predefinedFleets" : [ null, null ],
"organizationFleets" : [ null, null ],
"fleets" : [ {
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"sharedWithOrg" : true
}, {
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"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. v3Fleets
default
An unexpected error response. rpcStatus
get /v3/fleets/{fleetId}/vessels
(listVessels)
Retrieves list of vessels in a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource which vessels to be retrieved.
Return type
Example data
Content-Type: application/json
{
"vesselsInFleet" : 0,
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ]
}
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. v3Vessels
default
An unexpected error response. rpcStatus
get /v3/fleets/{fleetId}/vessels-with-status
(listVesselsWithStatus)
Retrieves list of vessels in a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource which vessels to be retrieved.
Query parameters
lastDays (optional)
Query Parameter — Number of last days from now for vessel StoppageEvents to be retrieved. Cannot be used alongside start_date and end_date. format: int32
startDate (optional)
Query Parameter — The UTC start date of the date filter for related events (StoppageEvents etc.).
endDate (optional)
Query Parameter — The UTC end date of the date filter for related events (StoppageEvents etc.).
Return type
Example data
Content-Type: application/json
{
"vesselsInFleet" : 0,
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ]
}
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. v3Vessels
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/rename-fleet
(renameFleet)
Changes the name of a Fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be renamed.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for renaming a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"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. v3Fleet
default
An unexpected error response. rpcStatus
post /v3/fleets/{fleetId}/replace-vessels
(replaceVessels)
Replaces the existing vessels in a Fleet with a batch of new vessels. This is equivalent to first calling DropVessels and then calling BatchAddVessels A maximum of 1000 vessels can be added to a fleet.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where vessels should be added.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for batch adding Vessels to a Fleet_1 (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. v3EmptyResponse
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/share-fleet
(shareFleet)
Sets the shared status of the Fleet to be shared.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be shared.
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"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. v3Fleet
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/unshare-fleet
(unshareFleet)
Sets the shared status of the Fleet to be not shared.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource to be shared.
Return type
Example data
Content-Type: application/json
{
"fleetName" : "fleetName",
"vesselsInFleet" : 0,
"organization" : "organization",
"ownerUserId" : "ownerUserId",
"fleetId" : "fleetId",
"platform" : "platform",
"vessels" : [ {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}, {
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
} ],
"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. v3Fleet
default
An unexpected error response. rpcStatus
put /v3/fleets/{fleetId}/vessels/{imo}
(updateVessel)
Updates existing metadata for a Vessel.
Path parameters
fleetId (required)
Path Parameter — Identifier of the Fleet resource where the vessel should be updated.
imo (required)
Path Parameter — IMO number of the vessel to be updated. format: int32
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body Request object for updating a vessel (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"dwt" : 1.4658129805029452,
"metadata" : {
"key" : "metadata"
},
"flagCode" : "flagCode",
"built" : 5,
"segment" : "segment",
"subSegment" : "subSegment",
"exName" : "exName",
"imo" : 6,
"stoppageEvents" : [ {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
}, {
"durationHours" : 4.145608029883936,
"endedAt" : "endedAt",
"minSpeedObserved" : 2.027123023002322,
"startedAt" : "startedAt",
"zoneId" : 3,
"lon" : 1.2315135367772556,
"portName" : "portName",
"zoneName" : "zoneName",
"portId" : 9,
"classification" : "classification",
"lat" : 7.386281948385884
} ],
"type" : "type",
"vesselName" : "vesselName",
"status" : {
"currentCommodityGroup" : "currentCommodityGroup",
"cargoStatus" : "cargoStatus",
"relatedPortName" : "relatedPortName",
"lastStaticReceivedAt" : "lastStaticReceivedAt",
"currentNavigationalStatus" : 7,
"draughtPercentage" : 5.637376656633329,
"destination" : "destination",
"destinationPortName" : "destinationPortName",
"ladenStatus" : "ladenStatus",
"portCallStatus" : "portCallStatus",
"currentSpeed" : 2.3021358869347655,
"lastPositionReceivedAt" : "lastPositionReceivedAt"
}
}
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. v3Vessel1
default
An unexpected error response. rpcStatus
post /v3/fleets/upload-fleet-list
(uploadFleetList)
Uploads file containing fleet data to be parsed into a batch of vessels.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetFleetListRequest (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. v3EmptyResponse
default
An unexpected error response. rpcStatus