Release 8.0
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.
An EventLog is also linked to ROBs to communicate the Remaining on Board (ROB) of a specific bunker during a specific event. For instance, the Rob of Fuel Oil (FO) on arrival will be specified by having the
robs
field on the arrival event log entry, containing the key of the FO 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
FO ROB
"eventLogs": {"robs": {"key": key of the arrival FO rob, "rob": ROB value}}
Remaining bunkers of type FO at the time of reporting
yes, updates PortCall's arrival FO rob
Double
MGO ROB
"eventLogs": {"robs": {"key": key of the arrival MGO rob, "rob": ROB value}}
Remaining bunkers of type MGO at the time of reporting
yes, updates PortCall's arrival MGO rob
Double
LS FO ROB
"eventLogs": {"robs": {"key": key of the arrival LS FO rob, "rob": ROB value}}
Remaining bunkers of type LS FO at the time of reporting
yes, updates PortCall's arrival LS FO rob
Double
LS MGO ROB
"eventLogs": {"robs": {"key": key of the arrival LS MGO rob, "rob": ROB value}}
Remaining bunkers of type LS MGO at the time of reporting
yes, updates PortCall's arrival FO rob
Double
Wind Direction
windDirection
Determines current wind direction
Average Wind Force
averageWindForce
General wind conditions
Double
Sea Direction
seaDirection
Current sea direction
Average Sea State
averageSeaState
General sea conditions
Double
Weather
weather
Determines current weather
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
Noon report example
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
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
FO ROB
"eventLogs": {"robs": "key": key of the FO rob, "rob": ROB value}
Remaining bunkers of type FO at the time of arrival
yes, updates and fixes PortCall's arrival FO ROB
Double
MGO ROB
"eventLogs": {"robs": "key": key of the arrival MGO rob, "rob": ROB value}
Remaining bunkers of type MGO at the time of arrival
yes, updates and fixes PortCall's arrival MGO ROB
Double
LS FO ROB
"eventLogs": {"robs": "key": key of the arrival LS FO rob, "rob": ROB value}
Remaining bunkers of type LS FO at the time of arrival
yes, updates and fixes PortCall's arrival LS FO ROB
Double
LS MGO ROB
"eventLogs": {"robs": "key": key of the arrival LS MGO rob, "rob": ROB value}
Remaining bunkers of type LS MGO at the time of arrival
yes, updates and fixes PortCall's arrival LS MGO ROB
Double
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
Arrival report example
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
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"
FO ROB
"eventLogs": {"robs": "key": key of the berth FO rob, "rob": ROB value}
Remaining bunkers of type FO at the time of berthing
yes, updates and fixes PortCall's berthing FO ROB
Double
LS FO ROB
"eventLogs": {"robs": "key": key of the berth LS FO rob, "rob": ROB value}
Remaining bunkers of type LS FO at the time of berthing
yes, updates and fixes PortCall's berthing LS FO ROB
Double
MGO ROB
"eventLogs": {"robs": "key": key of the berth MGO rob, "rob": ROB value}
Remaining bunkers of type MGO at the time of berthing
yes, updates and fixes PortCall's berthing MGO ROB
Double
LS MGO ROB
"eventLogs": {"robs": "key": key of the berth LS MGO rob, "rob": ROB value}
Remaining bunkers of type LS MGO at the time of berthing
yes, updates and fixes PortCall's berthing LS MGO ROB
Double
Berth report example
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
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"
FO ROB
"eventLogs": {"robs": "key": key of the unberth LS MGO rob, "rob": ROB value}
Remaining bunkers of type FO at the time of unberthing
yes, updates and fixes PortCall's unberthing FO ROB
Double
LS FO ROB
"eventLogs": {"robs": "key": key of the unberth LS MGO rob, "rob": ROB value}
Remaining bunkers of type LS FO at the time of unberthing
yes, updates and fixes PortCall's unberthing LS FO ROB
Double
MGO ROB
"eventLogs": {"robs": "key": key of the unberth LS MGO rob, "rob": ROB value}
Remaining bunkers of type MGO at the time of unberthing
yes, updates and fixes PortCall's unberthing MGO ROB
Double
LS MGO ROB
"eventLogs": {"robs": "key": key of the unberth LS MGO rob, "rob": ROB value}
Remaining bunkers of type LS MGO at the time of unberthing
yes, updates and fixes PortCall's unberthing LS MGO ROB
Double
Unberth report example
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
Weather
weather
Current weather
Click here for more details
Wind Direction
windDirection
Current wind direction
Click here for more details
Average Wind Force
averageWindForce
General wind conditions
Double
In port report example
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
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"
FO ROB
"eventLogs": {"robs": "key": key of the departure LS MGO rob, "rob": ROB value}
Remaining bunkers of type FO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
LS FO ROB
"eventLogs": {"robs": "key": key of the departure LS MGO rob, "rob": ROB value}
Remaining bunkers of type LS FO at the time of departure
yes, updates and fixes PortCall's departure LS FO ROB
Double
MGO ROB
"eventLogs": {"robs": "key": key of the departure LS MGO rob, "rob": ROB value}
Remaining bunkers of type MGO at the time of departure
yes, updates and fixes PortCall's departure MGO ROB
Double
LS MGO ROB
"eventLogs": {"robs": "key": key of the departure LS MGO rob, "rob": ROB value}
Remaining bunkers of type LS MGO at the time of departure
yes, updates and fixes PortCall's departure LS MGO ROB
Double
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
Departure Report example
More examples
Last updated