Welcome to the Veson Nautical Knowledge Base. In the Help Center, you can view the same articles and contact support as needed.
Port Call Service
- Laura Packard
(getPortCallTimeseries)
GetPortCallTimeseries retrieves aggregated counts for port calls for a set of request params.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetPortCallsRequest (required)
Body Parameter —
Return type
v3GetPortCallTimeseriesResponse
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"timeseries" : [ {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
}, {
"groupValue" : 0.8008281904610115,
"rows" : [ {
"date" : "date",
"value" : 6.027456183070403
}, {
"date" : "date",
"value" : 6.027456183070403
} ],
"group" : "group"
} ],
"csv" : "csv"
}
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. v3GetPortCallTimeseriesResponse
default
An unexpected error response. rpcStatus
post /v3/portcalls/listportcalls
(getPortCalls)
ListPortCalls retrieves lists all port calls for a set of request params. Response is paginated, and endpoint accepts a paging parameter to specify which page to return. It is also possible to set the number of port calls to return per query, default is 50 and maximum is 2000.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetPortCallsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"xlsx" : "xlsx",
"data" : [ {
"commodity" : "commodity",
"unberthedAt" : "unberthedAt",
"daysInPort" : 5.637376656633329,
"berthId" : 1,
"subSegment" : "subSegment",
"imo" : 0,
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"daysAtBerth" : 7.061401241503109,
"portVisited" : true,
"daysWaiting" : 2.3021358869347655,
"berthedAt" : "berthedAt",
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"departedAt" : "departedAt",
"anchorageId" : 5,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
}, {
"commodity" : "commodity",
"unberthedAt" : "unberthedAt",
"daysInPort" : 5.637376656633329,
"berthId" : 1,
"subSegment" : "subSegment",
"imo" : 0,
"portName" : "portName",
"portId" : 6,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"daysAtBerth" : 7.061401241503109,
"portVisited" : true,
"daysWaiting" : 2.3021358869347655,
"berthedAt" : "berthedAt",
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"departedAt" : "departedAt",
"anchorageId" : 5,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
} ],
"nextToken" : "nextToken",
"csv" : "csv",
"prevToken" : "prevToken"
}
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. v3GetPortCallsResponse
default
An unexpected error response. rpcStatus
post /v3/port/particulars
(getPortParticulars)
ListPortCalls retrieves lists all port calls for a given vessel. Response is paginated, and endpoint accepts a paging parameter to specify which page to return. It is also possible to set the number of port calls to return per query, default is 50 and maximum is 2000.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetPortParticularsRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"numberOfPortCalls" : 0,
"loa" : {
"percentile10" : 5.962133916683182,
"min" : 6.027456183070403,
"percentile99" : 9.301444243932576,
"max" : 1.4658129805029452,
"percentile50" : 5.637376656633329,
"mean" : 3.616076749251911,
"percentile95" : 7.061401241503109,
"percentile90" : 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. v3GetPortParticularsResponse
default
An unexpected error response. rpcStatus
post /v3/portcalls/vessels-in-port
(getVesselsInPort)
GetVesselsInPort lists all vessels that were within a port (or related anchorages) at a certain time.
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
Request body
body v3GetVesselsInPortRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
{
"data" : [ {
"dwt" : 5.962133916683182,
"commodity" : "commodity",
"berthStays" : [ {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
}, {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
} ],
"daysInPort" : 7.061401241503109,
"berthId" : 5,
"subSegment" : "subSegment",
"imo" : 6,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"portId" : 1,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"portVisited" : true,
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"anchorageStays" : [ {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
}, {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
} ],
"departedAt" : "departedAt",
"anchorageId" : 2,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
}, {
"dwt" : 5.962133916683182,
"commodity" : "commodity",
"berthStays" : [ {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
}, {
"arrivedAt" : "arrivedAt",
"berthId" : 3,
"draughtIn" : 2.027123023002322,
"draughtOut" : 4.145608029883936,
"departedAt" : "departedAt",
"hoursInBerth" : 7.386281948385884,
"berthName" : "berthName",
"berthType" : "berthType"
} ],
"daysInPort" : 7.061401241503109,
"berthId" : 5,
"subSegment" : "subSegment",
"imo" : 6,
"vesselStatus" : "vesselStatus",
"portName" : "portName",
"portId" : 1,
"berthName" : "berthName",
"voyageType" : "voyageType",
"arrivedAt" : "arrivedAt",
"countryCode" : "countryCode",
"segment" : "segment",
"portVisited" : true,
"commodityGroup" : "commodityGroup",
"unlocode" : "unlocode",
"anchorageStays" : [ {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
}, {
"anchorageName" : "anchorageName",
"arrivedAt" : "arrivedAt",
"hoursInAnchorage" : 1.0246457001441578,
"departedAt" : "departedAt",
"anchorageId" : 1
} ],
"departedAt" : "departedAt",
"anchorageId" : 2,
"volume" : 9.301444243932576,
"anchorageName" : "anchorageName",
"commodityValue" : "commodityValue",
"voyageId" : "voyageId",
"operation" : "operation",
"portCallId" : "portCallId",
"vesselName" : "vesselName"
} ],
"vesselsInPort" : 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. v3GetVesselsInPortResponse
default
An unexpected error response. rpcStatus
Still need help? Visit the Veson Nautical Help Center.
Copyright © 2017-2024 Veson Nautical LLC All Rights Reserved - Privacy Notice | End User Terms of Use