Overview
PositionReport is used to update the status of an ongoing voyage's port calls.
Overview
Position reports update a port call's sailing, arrival, in port, and departure status. Most fields in the PositionReport object will only provide information, while a few affect the port call's results.
The following fields will affect the port call's results:
eventLogs
An EventLog captures port events along with their dates and times. The port events include ARRIVAL, BERTHED, UNBERTHED, and DEPARTURE. To record the arrival date of a port call, an event log entry should include the ARRIVAL event along with the corresponding date.
A PositionReportBunker records the remaining bunkers on board for a specific bunker category.
Fields impacting the port call's results will have Major Change Factor marked as yes, along with a description, on the details.
PositionReport can be one of these types:
Noon Report
logs the ship's status at sea, updating the estimated arrival date and ROB info
Arrival Report
logs when the ship arrives in the port, fixing the arrival date and ROB info
Berth Report
logs when the ship has berthed in the port, fixing the berthed date and ROB info
Unberth Report
logs when the ship has unberthed in the port, fixing the unberthed date and ROB info
In Port Report
logs supplementary information such as hours in service, weather, wind direction and average wind direction when the ship is docked.
Departure Report
logs when the ship leaves the port, fixing the departure date and ROB info
In order to include a Remark on the position report, a separate API request must be made after the report is created. See here for an example.
Details
Noon Report
Report Type
vesselReportType
Determines the type of vessel report
yes
String
"NOON"
Noon Report Date
reportDateLocal
Date and time of creation of the report
yes
String
should be in this format: "YYYY-MM-DDTHH:mm:ss"
Port Call
portCall
Port to update
yes
Long
key of the port call
Latitude
latitude
Current position
yes
Double
Longitude
longitude
Current position
yes
Double
Estimated Time of Arrival
eventLogs
Date and time of estimated time of arrival
yes
yes, updates PortCall's arrival date
should be the key of the port call's arrival event log
date should be in this format: "YYYY-MM-DDTHH:mm:ss"
Remaining bunkers on board
"positionReportBunkers": [{"bunkerCategory": "FO", "rob":100}]
Remaining bunkers on board at the time of reporting for the given bunker category
yes, updates PortCall's arrival rob
one PositionReportBunker object for each bunker category
Average Wind Force
averageWindForce
General wind conditions
Double
Average Sea State
averageSeaState
General sea conditions
Double
Distance Sailed
distanceSailed
Distance sailed
Double
Hours in Service
hoursInService
Number of hours in operation
Double
Main Engine RPM
rpmFromLastPort
RPM recorded from previous port
Double
Fresh water ROB
robFw
Remaning fresh water on board
Double
Noon report example
Noon Report sailing to a port
Assuming the voyage key, and port call sequence are known, get the PortCall key with this query and headers:
An example of the response could be found here
Generate a Noon Report for the vessel that has sailed 3150 nm to the queried PortCall, with South/West wind direction and partly cloudy weather. Arrival LS MGO robs are also updated to 250
Arrival Report
Vessel Report Type
vesselReportType
Determines the type of vessel report
yes
String
"ARR"
Port Call
portCall
Port to update
yes
Long
key of the port call
Arrival Date
eventLogs
Date and time of arrival on port
yes
yes, updates and fixes PortCall's arrival date
should be the key of the port call's arrival event log
date should be in this format: "YYYY-MM-DDTHH:mm:ss"
Arrival Report Date
reportDateLocal
Date and time of creation of the report
String
should be in this format: "YYYY-MM-DDTHH:mm:ss"
Actual Distance Sailed Since Departure
distanceSailed
Distance in nm sailed from previous port
yes, updates the PortCall's actual distance sailed
Double
Remaining bunkers on board
"positionReportBunkers": [{"bunkerCategory": "FO", "rob":98}]
Remaining bunkers at the time of arrival for the given bunker category
yes, updates and fixes PortCall's arrival ROB
one PositionReportBunker object for each bunker category
Hours Stoppage
hoursStoppages
Number of hours in stoppage of operation
Double
Hours In Service
hoursInService
Number of hours in operation
Double
Speed Made Good
speedMadeGood
Net speed when sailing to the port
Double
Draft Aft
draftAft
Vessel's draft aft
Double
Draft Forward
draftForward
Vessel's draft forward
Double
Fresh water ROB
robFw
Remaning fresh water on board
Double
Arrival report example
Arrival report on port call
Assuming the voyage key, and port call sequence are known, get the PortCall key with this query:
Example of the response can be found here
Generate a report for arrival at 2nd August 2024 03:00 with arrival FO ROB at 225.85 mt and arrival LS MGO ROB at 235 mt
Berth Report
Vessel Report Type
vesselReportType
Determines the type of vessel report
yes
String
"BRT"
Port Call
portCall
Port to update
yes
Long
key of the port call
Berth date
eventLogs
Date and time of berthing on port
yes
yes, updates and fixes PortCall's berthed date
should be the key of the port call's berth event log
date should be in this format: "YYYY-MM-DDTHH:mm:ss"
Berth Report Date
reportDateLocal
Date and time of creation of the report
String
should be in this format: "YYYY-MM-DDTHH:mm:ss"
Remaining bunkers on board
"positionReportBunkers": [{"bunkerCategory": "FO", "rob":95}]
Remaining bunkers at the time of berthing for the given bunker category
yes, updates and fixes PortCall's berthing ROB
Fresh water ROB
robFw
Remaning fresh water on board
Double
Berth report example
Berth report on a port call
Assuming the voyage key, and port call sequence are known, get the PortCall key with this query:
Generate a report that has berthed 3rd August 2024 08:00 with berth FO rob at 225 mt and DL rob at 220 mt
Unberth Report
Vessel Report Type
vesselReportType
Determines the type of vessel report
yes
String
"UBRT"
Port Call
portCall
Port to update
yes
Long
key of the port call
Unberth date
eventLogs
Date and time of berthing on port
yes
yes, updates and fixes PortCall's berthed date
should be the key of the port call's unberth event log
date should be in this format: "YYYY-MM-DDTHH:mm:ss"
Unberth Report Date
reportDateLocal
Date and time of creation of the report
String
should be in this format: "YYYY-MM-DDTHH:mm:ss"
Remaining bunkers on board
"positionReportBunkers": [{"bunkerCategory": "FO", "rob":95}]
Remaining bunkers at the time of unberthing for the given bunker category
yes, updates and fixes PortCall's unberthing ROB
Fresh water ROB
robFw
Remaning fresh water on board
Double
Unberth report example
Unberth report on a port call
Assuming the voyage key, and port call sequence are known, get the PortCall key with this query:
Example response can be found here
Generate a report that has unberthed 5th August 2024 08:00, FO unberth ROB at 225 mt, DL unberth at 218.5 mt
In Port Report
Vessel Report Type
vesselReportType
Determines the type of vessel report
yes
String
"PORT"
Port Call
portCall
Port to update
yes
Long
key of the port call
In Port Report Date
reportDateLocal
Date and time of creation of the report
String
should be in this format: "YYYY-MM-DDTHH:mm:ss"
Hours In Service
hoursInService
Number of hours in operation
Double
Average Wind Force
averageWindForce
General wind conditions
Double
In port report example
In port report on a port call
Assuming the voyage key, and port call sequence are known, get the PortCall key with this query:
Generate a report to log sunny weather, East wind direction, hours in service, average wind force status in port
Departure Report
Vessel Report Type
vesselReportType
Determines the type of vessel report
yes
String
"DEP"
Port Call
portCall
Port to update
yes
Long
key of the port call
Departure date
eventLogs
Date and time of departure from port
yes
yes, updates and fixes PortCall's departure date
should be the key of the port call's departure event log
date should be in this format: "YYYY-MM-DDTHH:mm:ss"
Departure Report Date
reportDateLocal
Date and time of creation of the report
String
should be in this format: "YYYY-MM-DDTHH:mm:ss"
Remaining bunkers on board
"positionReportBunkers": [{"bunkerCategory": "FO", "rob":90}]
Remaining bunkers at the time of departure for the given bunker category
yes, updates and fixes PortCall's departure ROB
one PositionReportBunker object for each bunker category
Distance to next port
distanceToNextPort
Distance in nm to next port
Double
Draft Aft
draftAft
Vessel's draft aft
Double
Draft Forward
draftForward
Vessel's draft forward
Double
Fresh water ROB
robFw
Remaning fresh water on board
Double
Departure Report example
Departure report on a port call
Assuming the voyage key, and port call sequence are known, get the PortCall key with this query:
Example of the response can be found here
Generate a report that has fixes the departure date to 5th August 2024 08:30, departure FO rob at 225 mt and departure DL rob at 215 mt
More examples
Arrival report with Remark
Send first this request
Example: Arrival vessel report to register arrival date at 8th August 2024 02:58, with remaining 98 MT of FO on board
The response of the query above returns the PositionReport key. Generate a Remark on the arrival position report that says "Arrival on the port remark":
Was this helpful?