Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
PositionReport is used to update the status of an ongoing voyage's port calls.
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 date and time. The port events include ARRIVAL, BERTHED, UNBERTHED, and DEPARTURE.
For example, to record the arrival date of a port call, an event log entry should include the ARRIVAL event along with the corresponding date
robFo, robFl, robDl, robDo
An EventLog is also linked to ROBs to communicate the ROB of a specific bunker during a specific event.
For instance, the robFo linked to the arrival event log is the ROB of FO on arrival. The robFo linked to the departure event log is the ROB of FO on departure, etc.
Fields impacting the port call's results will have Major Change Factor marked as yes, along with a description, on the .
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 on the position report, a separate API request needs to be done after the report is created.
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
robFo
Remaining bunkers of type FO at the time of reporting
yes, updates PortCall's arrival FO rob
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of reporting
yes, updates PortCall's arrival MGO rob
Double
LS FO ROB
robFl
Remaining bunkers of type LS FO at the time of reporting
yes, updates PortCall's arrival LS FO rob
Double
LS MGO ROB
robDl
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
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
robFo
Remaining bunkers of type FO at the time of arrival
yes, updates and fixes PortCall's arrival FO ROB
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of arrival
yes, updates and fixes PortCall's arrival MGO ROB
Double
LS FO ROB
robFl
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
robDl
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
Daily FO
dailyFo
Daily FO consumption
Double
Daily LS FO
dailyFl
Daily LS FO consumption
Double
Daily MGO
dailyDo
Daily MGO consumption
Double
Daily LS MGO
dailyDl
Daily LS MGO consumption
Double
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
robFo
Remaining bunkers of type FO at the time of berthing
yes, updates and fixes PortCall's berthing FO ROB
Double
LS FO ROB
robFl
Remaining bunkers of type LS FO at the time of berthing
yes, updates and fixes PortCall's berthing FO ROB
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of berthing
yes, updates and fixes PortCall's berthing FO ROB
Double
LS MGO ROB
robDl
Remaining bunkers of type LS MGO at the time of berthing
yes, updates and fixes PortCall's berthing FO ROB
Double
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
robFo
Remaining bunkers of type FO at the time of unberthing
yes, updates and fixes PortCall's unberthing FO ROB
Double
LS FO ROB
robFl
Remaining bunkers of type LS FO at the time of unberthing
yes, updates and fixes PortCall's unberthing FO ROB
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of unberthing
yes, updates and fixes PortCall's unberthing FO ROB
Double
LS MGO ROB
robDl
Remaining bunkers of type LS MGO at the time of unberthing
yes, updates and fixes PortCall's unberthing FO ROB
Double
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
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
robFo
Remaining bunkers of type FO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
LS FO ROB
robFl
Remaining bunkers of type LS FO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
LS MGO ROB
robDl
Remaining bunkers of type LS MGO at the time of departure
yes, updates and fixes PortCall's departure FO 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
Direction id
Direction Description
North
South
East
West
North/East
North/West
South/East
South/West
Various
North/North/East
East/North/East
East/South/East
South/South/East
South/South/West
West/South/West
West/North/West
North/North/West
East/by/North
East/by/South
North/by/East
North/by/West
NE/by/East
NE/by/north
NW/by/North
NW/by/West
SE/by/East
SE/by/South
SW/by/South
SW/by/West
South/by/East
South/by/West
West/by/North
West/by/South
Weather ID
Weather Description
Clear Sky
Sunny Day
Partly Cloudy
Sunny Intervals
Dust
Mist
Fog
Medium-Level Cloud
Low-Level Cloud
Light Rain Shower
Drizzle
Light Rain
Heavy Rain Shower
Heavy Rain
Sleet Shower
Sleet
Hail Shower
Hail
Light Snow Shower
Light Snow
Heavy Snow Shower
Heavy Snow
Thundery Shower
Thunder Storm
Tropical Storm
Haze
Dataloy Vessel Report System enables vessels to send vessel reports without proper internet connection. The server side of Dataloy VRS is exposed in the Dataloy API for inserting vessel reports into Dataloy VMS. When Dataloy VRS is in use, the client side of the Vessel Report API system can be ignored - the message sent by e-mail to the VRS is identical to what can be posted in the Vessel Report API (with minor adjustments). Inserting a vessel report into Dataloy VMS not only inserts a position report, but also the schedule, bunkers etc. There is also a functionality available for locating correct port call based on vessel code and report date.
Chapter Contents:
Base URL
The Vessel Report URL:
Base URL + ws/rest/VesselReport
Custom Fields
Custom fields can be added
using Events (if there is an event code and date).
or added as a Remark (text field).
Events are added and retrieved from Master Data and can be used in a JSON message. Event fields in the JSON message is shortened:
ed = event date
ec = event code.
Remarks will be connected to the Position Report. To send remarks requires:
the set-up of a remark template in the database with a title and the extraction of the remark_id. Note: This construction is usually met with various various challenges with e-mail based vessel reporting (more information: contact Dataloy).
IMPORTANT: This type of construction causes various challenges with e-mail based vessel reporting (more information: contact contact Dataloy).
Alerts can be triggered either:
when reports are inserted to Dataloy VMS
or a report is failing.
IMPORTANT: Property Settings is handled in: Master Data > Dataloy Properties.
Properties
Property
Description
com.dataloy.integration.vessel.voyageNoAndRFC
When set to true: referenceNo and reasonForCall can be added to the json message. This makes it easier for VRS to locate the correct port call and will reduce errors.
com.dataloy.integration.vessel.reportMailRecipients
List of email addresses separated by semicolon.
A vessel report successfully inserted into Dataloy VMS results in a report being sent to the addresses in this property value. The report will list all values sent from the vessel.
com.dataloy.integration.vessel.errormail.recipient
E-mail address list separated by semicolon.
The e-mail address owners will receive an e-mail if a vessel report is failing.
The Voyage Operator will also receive a message if the User has registered relevant e-mail address.
com.dataloy.integration.vessel.errormail.sender
An e-mail address will be the sender of the Error Mail.
com.dataloy.integration.vessel.sendReportMailToOperator
When set to true: A vessel report successfully inserted into Dataloy VMS results in a report being sent to the Voyage Operator, listing all values sent from the vessel.
com.dataloy.mail.smtp
smtp must be setup for e-mail alerts to function.
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
portCallId
A port call id
If the port call id is available, use this to avoid VRS trying to locate the correct port call.
referenceNo
Voyage reference number
reasonForCall
Vessel Report Type
Value = NOON for Noon Report
Used to insert correct type of Position Report and to locate correct port call.
Yes
String
4
Used in combination with report date local time to locate the port call in Dataloy VMS.
Yes
String
6
Report Date Local Time
Used in combination with vessel code to locate the port call in Dataloy VMS. Inserted in the Postition Report.
Yes
Date
Position Latitude (Decimal Degrees)
Inserted in Position Report.
Double
5
Position Longitude (Decimal Degress)
Inserted in Position Report.
Double
5
When a port call is located based on vessel and report date, Dataloy VMS checks the reported port against the port in Dataloy VMS. If these do not match an error message will be returned and the report will not be inserted.
Yes
Integer
38
Estimated Time of Arrival
Updates ETA in Schedule.
Yes
Date
Estimated Time of Berthing
Updates ETB in Schedule.
Date
Estimated Time of Departure
Updates ETD in Schedule.
Date
True Course
Inserted in Position Report.
Integer
38
Distance Sailed Since Last Report
Inserted in Position Report.
Double
Hours in Service Since Last Report
Inserted in Position Report.
Double
Distance To Go
Inserted in Position Report.
Double
Speed Made Good
Inserted in Position Report.
Double
Inserted in Position Report.
Integer
38
Wind Force. Beaufort.
Inserted in Position Report.
Integer
38
Inserted in Position Report.
Integer
38
Sea State. Integer from 0 - 9.
Inserted in Position Report.
Integer
38
Main Engine RPM Since Last Report
Inserted in Position Report.
Double
Daily Fuel Oil Consumption
Inserted in Position Report.
Double
Daily Diesel Oil Consumption
Inserted in Position Report.
Double
Daily Fuel Oil Low Sulphur Consumption
Inserted in Position Report.
Double
Daily Diesel Oil Low Sulphur Consumption
Inserted in Position Report.
Double
Daily Net Fresh Water Consumption
Inserted in Position Report.
Double
Fuel Oil Remaining on Board (FO RoB)
Inserted in Position Report.
Double
Diesel Oil Remaining on Board (DO RoB)
Inserted in Position Report.
Double
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)
Inserted in Position Report.
Double
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)
Inserted in Position Report.
Double
Fresh Water Remaining on Board
Inserted in Position Report.
Double
Remark
Inserted as a Remark to the Position Report.
String
Unlimited
JSON Field Name
Description
Affets Dataloy VMS
Mandatory
Type
Length
portCallId
A port call id
If the port call id is available, use this to avoid VRS trying to locate the correct port call.
referenceNo
Voyage reference number
reasonForCall
Vessel Report Type Value = ARR for Arrival Report.
Used to insert the correct type of Position Report and to locate the correct port call.
Yes
String
4
Used in combination with report date local time to locate the port call in Dataloy VMS.
Yes
String
6
When a port call is located based on vessel and report date, Dataloy VMS checks the reported port against the port in Dataloy VMS. If these do not match an error message will be returned and the report will not be inserted.
Yes
Integer
38
Report Date Local Time
Used in combination with vessel code to locate the port call in Dataloy VMS.
Yes
Date
Time of Arrival
Updates ETA in Schedule.
Yes
Date
Time of Berthing (Estimated if Anchoring)
Updates ETB in Schedule
Yes
Date
Estimated Time of Departure
Updates ETD in Schedule.
Yes
Date
Total Distance Sailed Since Departure
Updates Miles in Schedule.
Double
Distance Sailed Since Last Report
Inserted in Postion Report.
Double
Hours Stoppages
Updates Days Stoppages (see the Perfomance tab in Booking and Operations).
Double
Hours in Service
Inserted in Postion Report.
Double
Speed Made Good Since Last Report
Inserted in Postion Report.
Double
Draft Aft
Inserted in Postion Report.
Double
Draft Forward
Inserted in Postion Report.
Double
Daily Fuel Oil Consumption
Inserted in Postion Report.
Double
Daily Diesel Oil Consumption
Inserted in Postion Report.
Double
Daily Fuel Oil Low Sulphur Consumption
Inserted in Postion Report.
Double
Daily Diesel Oil Low Sulphur Consumption
Inserted in Postion Report.
Double
Daily Net Fresh Water consumption
Inserted in Postion Report.
Double
Fuel Oil Remaining on Board (FO RoB)
Updates Fuel Oil Remaining on Board (FO RoB) Arrival.
Double
Diesel Oil Remaining on Board (DO RoB)
Updates Diesel Oil Remaining on Board (DO RoB) Arrival.
Double
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)
Updates Fuel Oil Low Sulphur Remaining on Board (FO LS RoB) Arrival.
Double
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)
Updates Diesel Oil Low Sulphur Remaining on Board (DO LS RoB) Arrival.
Double
Fresh Water remaining on board
Inserted in Postion Report.
Double
Remark
Inserted as a Remark to the Position Report.
String
Unlimited
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
portCallId
A port call id
If the port call id is available, use this to avoid VRS trying to locate the correct port call.
referenceNo
Voyage reference number
reasonForCall
Vessel Report Type Value = PORT for In Port Report.
Used to insert the correct type of Position Report and to locate the correct port call.
Yes
String
4
Used in combination with report date local time to locate the port call in Dataloy VMS.
Yes
String
6
When a port call is located based on vessel and report date, Dataloy VMS checks the reported port against the port in Dataloy VMS. If these do not match an error message will be returned and the report will not be inserted.
Yes
Integer
38
Report Date Local Time
Used in combination with vessel code to locate the port call in Dataloy.
Yes
Date
Estimated Time of Berthing
Updates ETB in Schedule
Date
Estimated Time of Departure
Updates ETD in Schedule.
Yes
Date
Hours in Service
Inserted in Postion Report.
Double
Inserted in Postion Report.
Integer
38
Inserted in Postion Report.
Integer
38
Average Wind Force. Beaufort.
Inserted in Postion Report.
Integer
38
Remark
Inserted as a Remark to the Position Report.
String
Unlimited
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
portCallId
A port call id
If the port call id is available, use this to avoid VRS trying to locate the correct port call.
referenceNo
Voyage reference number
reasonForCall
Vessel Report Type. Value = DEP for Departure Report.
Used to insert the correct type of position report and to locate the correct port call.
Yes
String
4
Used in combination with report date local time to locate the port call in Dataloy VMS.
Yes
String
6
When a port call is located based on vessel and report date, Dataloy VMS checks the reported port against the port in Dataloy VMS. If these do not match an error message will be returned and the report will not be inserted.
Yes
Integer
38
Report Date Local Time
Used in combination with vessel code to locate the port call in Dataloy VMS.
Yes
Date
Departure Time
Updates Estimated Time of Departure (ETD) in Schedule.
Yes
Date
When a port call is located based on vessel and report date, Dataloy VMS checks the reported port against the port in Dataloy VMS. If these do not match an e-mail will be sent to the operator and the report will not be inserted.
Integer
38
Estimated Time of Arrival
Updates Estimate Time of Arrival (ETA) for next Arrival Port.
Date
Distance To Next Port
Inserted in Postion Report.
Double
Draft Aft
Inserted in Postion Report.
Double
Draft Forward
Inserted in Postion Report.
Double
Fuel Oil Remaining on Board (FO RoB)
Updates Fuel Oil Remaining on Board (FO RoB) departure.
Double
Diesel Oil Remaining on Board (DO RoB)
Updates Diesel Oil Remaining on Board (DO RoB) departure.
Double
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)
Updates Fuel Oil Low Sulphur Remaining on Board (FO LS RoB) departure.
Double
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)
Updates Diesel Oil Low Sulphur Remaining on Board (FO LS RoB) departure.
Double
Fresh Water Remaining on Board
Inserted in Postion Report.
Double
Bunkered Fuel Oil Input Exact Figure According to BDR
Updates Fuel Oil bunkered for departure port call.
Double
Bunkered Fuel Oil Low Sulphur Input exact figure according to the BDR
Updates Fuel Oil Low Sulphur bunkered for departure port call.
Double
Bunkered Diesel Oil Input exact figure according to the BDR
Updates Diesel Oil bunkered for departure port call.
Double
Bunkered Diesel Oil Low Sulphur Input exact figure according to the BDR
Updates Diesel Oil Low Sulphur bunkered for departure port call.
Double
Remark
Inserted as remark to position report.
String
Unlimited
Updated for API version 2.0.0 using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)
Arrival
Departure
{ "remarks":[ { "id":"70495513", "r":"10" }, { "id":"70495512", "r":"10" }, { "id":"70495511", "r":"10" }, { "id":"70495510", "r":"10" }, { "id":"70495509", "r":"10" }, { "id":"70495514", "r":"10" }, { "id":"70495515", "r":"10" }, { "id":"70495516", "r":"10" }, { "id":"70495517", "r":"10" }, { "id":"70495518", "r":"10" }, { "id":"70495519", "r":"10" } ], "events":[ { "ed":"2013-12-24T00:00:00", "ec":"VR15" }, { "ed":"2013-12-24T00:00:00", "ec":"VR20" }, { "ed":"2013-12-24T00:00:00", "ec":"VR25" }, { "ed":"2013-12-24T00:00:00", "ec":"VR30" }, { "ed":"2013-12-24T00:00:00", "ec":"VR40" }, { "ed":"2013-12-24T00:00:00", "ec":"VR45" }, { "ed":"2013-12-24T00:00:00", "ec":"VR50" }, { "ed":"2013-12-24T00:00:00", "ec":"VR55" } ], "reportTypeCode":"DEP", "vesselCode":"14", "portId":"104419", "reportDateLocal":"2013-12-24T00:00:00", "departure":"2013-12-24T00:00:00", "nextPortId":"104419", "arrival":"2013-12-24T00:00:00", "distanceToNextPort":"10", "draftAft":"10", "draftForward":"10", "robFo":"10", "robDo":"10", "robFl":"10", "robDl":"10", "robFw":"10", "foBunkered":"10", "flBunkered":"10", "doBunkered":"10", "dlBunkered":"10", "genericRemark":"Remark"}
Noon
Port
The following fields can be added for consumption breakdown
Main Engine - Fuel Oil
Inserted to position report.
Main Engine - Fuel Oil Low Sulphur
Inserted to position report.
Main Engine - Diesel Oil
Inserted to position report.
Main Engine - Diesel Oil Low Sulphur
Inserted to position report.
Auxiliary - Fuel Oil At Sea
Inserted to position report.
Auxiliary - Fuel Oil Low Sulphur At Sea
Inserted to position report.
Auxiliary - Diesel Oil At Sea
Inserted to position report.
Auxiliary - Diesel Oil Low Sulphur At SeaInserted to position report.
Inserted to position report.
Boilers - Fuel Oil Idle
Inserted to position report.
Boilers - Fuel Oil Low Sulphur Idle
Inserted to position report.
Boilers - Diesel Oil Idle
Inserted to position report.
Boilers - Diesel Oil Low Sulphur Idle
Inserted to position report.
Boilers - Fuel Oil Working
Inserted to position report.
Boilers - Fuel Oil Low Sulphur Working
Inserted to position report.
Boilers - Diesel Oil Working
Inserted to position report.
Boilers - Diesel Oil Low Sulphur Working
Inserted to position report.
Generators - Fuel Oil At Sea
Inserted to position report.
Generators - Fuel Oil Low Sulphur At Sea
Inserted to position report.
Generators - Diesel Oil At Sea
Inserted to position report.
Generators - Diesel Oil Low Sulphur At Sea
Inserted to position report.
Cleaning - Fuel Oil
Inserted to position report.
Cleaning - Fuel Oil Low Sulphur
Inserted to position report.
Cleaning - Diesel Oil
Inserted to position report.
Cleaning - Diesel Oil Low Sulphur
Inserted to position report.
Heating - Fuel Oil Consumption
Inserted to position report.
Heating - Fuel Oil Low Sulphur
Inserted to position report.
Heating - Diesel Oil
Inserted to position report.
Heating - Diesel Oil Low Sulphur
Inserted to position report.
When inserting weather data, use the ID from the Weather Data table:
Weather ID
Weather Description
Clear Sky
Sunny Day
Partly Cloudy
Sunny Intervals
Dust
Mist
Fog
Medium-Level Cloud
Low-Level Cloud
Light Rain Shower
Drizzle
Light Rain
Heavy Rain Shower
Heavy Rain
Sleet Shower
Sleet
Hail Shower
Hail
Light Snow Shower
Light Snow
Heavy Snow Shower
Heavy Snow
Thundery Shower
Thunder Storm
Tropical Storm
Haze
When inserting direction, use the ID from the Direction Table:
Direction id
Direction Description
North
South
East
West
North/East
North/West
South/East
South/West
Various
North/North/East
East/North/East
East/South/East
South/South/East
South/South/West
West/South/West
West/North/West
North/North/West
East/by/North
East/by/South
North/by/East
North/by/West
NE/by/East
NE/by/north
NW/by/North
NW/by/West
SE/by/East
SE/by/South
SW/by/South
SW/by/West
South/by/East
South/by/West
West/by/North
West/by/South
Code
Description
L
Loading
D
Discharging
C
Canal Passage
E
Extra Port
DD
Dry Dock
DEL
Delivery
RED
Redelivery
B
Bunkering
R
Repair
CL
Tank / Hold Cleaning
STS
Ship to Ship
W
Waiting
CC
Customs Clearance
Dataloy Vessel Codes can be found by using the Vessel Code Resource.
Dataloy Port ID's can be found be using the Port Resource.
PositionReport is used to update the status of an ongoing voyage's port calls.
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 date and time. The port events include ARRIVAL, BERTHED, UNBERTHED, and DEPARTURE.
For example, to record the arrival date of a port call, an event log entry should include the ARRIVAL event along with the corresponding date
robFo, robFl, robDl, robDo
An EventLog is also linked to ROBs to communicate the ROB of a specific bunker during a specific event.
For instance, the robFo linked to the arrival event log is the ROB of FO on arrival. The robFo linked to the departure event log is the ROB of FO on departure, etc.
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
In Port Report
logs when the ship docks in the port. You can update both berthed and departure events here. This fixes the berthed date.
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 needs to be done after the report is created.
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
robFo
Remaining bunkers of type FO at the time of reporting
yes, updates PortCall's arrival FO rob
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of reporting
yes, updates PortCall's arrival MGO rob
Double
LS FO ROB
robFl
Remaining bunkers of type LS FO at the time of reporting
yes, updates PortCall's arrival LS FO rob
Double
LS MGO ROB
robDl
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
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
robFo
Remaining bunkers of type FO at the time of arrival
yes, updates and fixes PortCall's arrival FO ROB
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of arrival
yes, updates and fixes PortCall's arrival MGO ROB
Double
LS FO ROB
robFl
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
robDl
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
Daily FO
dailyFo
Daily FO consumption
Double
Daily LS FO
dailyFl
Daily LS FO consumption
Double
Daily MGO
dailyDo
Daily MGO consumption
Double
Daily LS MGO
dailyDl
Daily LS MGO consumption
Double
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"
Estimated time of berthing and departure
eventLogs
Estimated date and time of berthing and departure from port
yes, updates PortCall's berthing and departure dates
date 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
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
robFo
Remaining bunkers of type FO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
LS FO ROB
robFl
Remaining bunkers of type LS FO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
MGO ROB
robDo
Remaining bunkers of type MGO at the time of departure
yes, updates and fixes PortCall's departure FO ROB
Double
LS MGO ROB
robDl
Remaining bunkers of type LS MGO at the time of departure
yes, updates and fixes PortCall's departure FO 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
PositionReport is used to update the status of an ongoing voyage's port calls.
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.
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
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
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
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
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
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
This page explains how to create vessel report integration with Dataloy API.
Have you considered using the vessel reporting functionality in our new web client? for more information.
Chapter Contents:
The vessel report endpoint is called PositionReport and can be accessed with Base URL + ws/rest/PositionReport
A vessel report needs to be connected to a port call. Dataloy recommends to present a list of port calls to the user to make them select the correct one when reporting. To get a list of port calls, the following API call can be used
Remarks will be connected to the Position Report. To send remarks requires:
Noon reports at sea should be connected to the next port call
Note
Fields that would be fixed will only fixed for voyages that are not estimated, allocated or scheduled
Arrival
Departure
Noon
When inserting weather data, use the ID from the Weather Data table:
When inserting direction, use the ID from the Direction Table:
For long TC out voyages you might want to make it possible to add port calls from your vessel client. This section will explain how to do that.
To insert a port call the following API call can be used
Field explanation: Port
A port key. Get a list of all ports with the below API call. We have over 10,000 ports. Please keep the number of requests to this endpoint as low as possible with caching. We do add new ports so if the vessel needs a newly added port it must be possible to update the cache, this will not happen often.
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Arrival Port,
Wind Direction ()
Sea Direction ()
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Arrival Port,
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Port,
Weather.
Wind Direction.
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Makes it easier for VRS to locate correct port call which results in less errors. Requires a .
Departure Port,
Next Arrival Port,
the set-up of a remark template in the database with a title and the extraction of the remark_id. Note: This construction is usually met with various various challenges with e-mail based vessel reporting (more information: ).
IMPORTANT: This type of construction causes various challenges with e-mail based vessel reporting (more information: contact ).
Updated for using the new required date format yyyy-dd-MMThh:mi:ss to conform ISO 8601, (prior version has date format: yyyy-dd-MM hh:mi:ss)
Reason for call Any of the codes from the reason for call list above Port Call Sequence Should be port call sequence from last port call + 1. The port call sequence is returned in Voyage A voyage key. The voyage key is returned in . Event Logs There needs to be one eventLog for ARR (arrival), BRT (berthing), DEP (departure). Set the dates to todays date, they will then be calculated by the server. After inserting the port call, again to get the ETA, ETB and ETD calculated by the server.
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
Example
Client validation
A port call key
Yes
Vessel Report Type
Value = NOON for Noon Report
Yes
String
4
Report Date Local Time
Yes
Date
Position Latitude (Decimal Degrees)
Double
5
12.575
User input should be degrees, minutes and seconds. For example: 12° 34'5 N. Then degrees, minutes and seconds should be converted to decimals.
Validation:
if (minutes > 60) {
return false; } if (direction === 'S' || direction === 'N') { if (degrees > 90) { return false; } if (degrees === 90 && minutes > 0) { return false; } } if (direction === 'E' || direction === 'W') { if (degrees > 180) { return false; } if (degrees === 180 && minutes > 0) { return false; } } return true;
Position Longitude (Decimal Degrees)
Double
5
123.76
Same validation as for latitude
Array of EventLog.
For noon report this can be estimated time of arrival, berthing and departure. All dates are in local time.
It's not necessary to include all 3 types. If you only want to update arrival then only include arrival EventLog
Arrival event = ARR
Berthing event = BRT
Departure event = DEP
Updates ETA, ETB and ETD
Array of EventLogs
[{eventLogDate: "2023-01-03T03:34:00.000Z", event: "ARR"},
{eventLogDate: "2023-01-03T03:34:00.000Z", event: "BRT"},
{eventLogDate: "2023-01-03T03:34:00.000Z", event: "DEP"}]
True Course
Integer
38
Distance Sailed Since Last Report
Double
Positive decimal value
Hours in Service Since Last Report
Double
Positive decimal value
Distance To Go
Double
Positive decimal value
Speed Made Good
Double
Positive decimal value
Wind Direction (direction)
Integer
38
One of the values from this list: direction
Wind Force. Beaufort.
Integer
38
0-12
Sea Direction (direction)
Integer
38
One of the values from this list: direction
Sea State. Integer from 0 - 9.
Integer
38
0-9
weather
Weather. weather
Integer
38
One of the values from this list: weather
Main Engine RPM Since Last Report
Double
Positive decimal value
Daily Fuel Oil Consumption
Double
Positive decimal value
Daily Diesel Oil Consumption
Double
Positive decimal value
Daily Fuel Oil Low Sulphur Consumption
Double
Positive decimal value
Daily Diesel Oil Low Sulphur Consumption
Double
Positive decimal value
Daily Net Fresh Water Consumption
Double
Positive decimal value
Fuel Oil Remaining on Board (FO RoB)
Updates FO arrival RoB of the Port Call
Double
Positive decimal value
Diesel Oil Remaining on Board (DO RoB)
Updates DO arrival RoB of the Port Call
Double
Positive decimal value
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)
Updates FO LS arrival RoB of the Port Call
Double
Positive decimal value
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)
Updates DO LS arrival RoB of the Port Call
Double
Positive decimal value
Fresh Water Remaining on Board
Double
Positive decimal value
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
Example
Client validation
A port call key
Yes
Integer
Vessel Report Type Value = ARR for Arrival Report.
Yes
String
4
Report Date Local Time
Yes
Date
Array of EventLog.
For departure report this can be time of arrival, estimated time of berthing and departure. All dates are in local time.
It's not necessary to include all 3 types. If you only want to update arrival then only include arrival EventLog
Arrival event = ARR
Berthing event = BRT
Departure event = DEP
Updates and fixes Arrival Date and Time in Schedule
Updates ETB and/or ETD in Schedule
Yes
Array of EventLogs
[{eventLogDate: "2023-01-03T03:34:00.000Z", event: "ARR"},
{eventLogDate: "2023-01-03T03:34:00.000Z", event: "BRT"},
{eventLogDate: "2023-01-03T03:34:00.000Z", event: "DEP"}]
Distance Sailed Since departure
Updates actual distance sailed
Double
Positive decimal value
Hours Stoppages
Double
Positive decimal value
Hours in Service
Double
Positive decimal value
Speed Made Good Since Last Report
Double
Positive decimal value
Draft Aft
Double
Positive decimal value
Draft Forward
Double
Positive decimal value
Daily Fuel Oil Consumption
Double
Positive decimal value
Daily Diesel Oil Consumption
Double
Positive decimal value
Daily Fuel Oil Low Sulphur Consumption
Double
Positive decimal value
Daily Diesel Oil Low Sulphur Consumption
Double
Positive decimal value
Daily Net Fresh Water consumption
Double
Positive decimal value
Fuel Oil Remaining on Board (FO RoB)
Updates and fixes Fuel Oil Remaining on Board (FO RoB) Arrival.
Double
Positive decimal value
Diesel Oil Remaining on Board (DO RoB)
Updates and fixes Diesel Oil Remaining on Board (DO RoB) Arrival.
Double
Positive decimal value
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)
Updates and fixes Fuel Oil Low Sulphur Remaining on Board (FO LS RoB) Arrival.
Double
Positive decimal value
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)
Updates and fixes Diesel Oil Low Sulphur Remaining on Board (DO LS RoB) Arrival.
Double
Positive decimal value
Fresh Water remaining on board
Double
Positive decimal value
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
Example
Client validation
A port call key
Yes
Integer
Vessel Report Type Value = PORT for In Port Report.
Used to insert the correct type of Position Report and to locate the correct port call.
Yes
String
4
Report Date Local Time
Yes
Date
Array of EventLog.
For in port report this can be time of berthing and estimated time of departure. All dates are in local time.
It's not necessary to include all types. If you only want to update arrival then only include arrival EventLog
Berthing event = BRT
Departure event = DEP
Updates and fixes Berthed Time and Date
Updates ETD in Schedule
Yes
Date
[{eventLogDate: "2023-01-03T03:34:00.000Z", event: "BRT"},
{eventLogDate: "2023-01-03T03:34:00.000Z", event: "DEP"}]
Hours in Service
Double
Positive decimal value
Weather. weather
Integer
38
One of the values from this list: weather
Wind Direction. direction
Integer
38
One of the values from this list: direction
Average Wind Force. Beaufort.
Integer
38
0-12
JSON Field Name
Description
Affects Dataloy VMS
Mandatory
Type
Length
Example
Client validation
A port call key
Yes
Vessel Report Type. Value = DEP for Departure Report.
Yes
String
4
Report Date Local Time
Yes
Date
Array of EventLog. Local time.
Add Departure Time as an Event Log with "DEP" event code
Updates and fixes Departure Time in Schedule.
Yes
Date
[{eventLogDate: "2023-01-03T03:34:00.000Z", event: "DEP"}]
Distance To Next Port
Double
Positive decimal value
Draft Aft
Double
Positive decimal value
Draft Forward
Double
Positive decimal value
Fuel Oil Remaining on Board (FO RoB)
Updates and fixes Fuel Oil Remaining on Board (FO RoB) departure.
Double
Positive decimal value
Diesel Oil Remaining on Board (DO RoB)
Updates and fixes Diesel Oil Remaining on Board (DO RoB) departure.
Double
Positive decimal value
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)
Updates and fixes Fuel Oil Low Sulphur Remaining on Board (FO LS RoB) departure.
Double
Positive decimal value
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)
Updates and fixes Diesel Oil Low Sulphur Remaining on Board (FO LS RoB) departure.
Double
Positive decimal value
Fresh Water Remaining on Board
Double
Positive decimal value
Bunkered Fuel Oil Input Exact Figure According to BDR
Updates Fuel Oil bunkered for departure port call.
Double
Positive decimal value
Bunkered Fuel Oil Low Sulphur Input exact figure according to the BDR
Updates Fuel Oil Low Sulphur bunkered for departure port call.
Double
Positive decimal value
Bunkered Diesel Oil Input exact figure according to the BDR
Updates Diesel Oil bunkered for departure port call.
Double
Positive decimal value
Bunkered Diesel Oil Low Sulphur Input exact figure according to the BDR
Updates Diesel Oil Low Sulphur bunkered for departure port call.
Double
Positive decimal value
Clear Sky
Sunny Day
Partly Cloudy
Sunny Intervals
Dust
Mist
Fog
Medium-Level Cloud
Low-Level Cloud
Light Rain Shower
Drizzle
Light Rain
Heavy Rain Shower
Heavy Rain
Sleet Shower
Sleet
Hail Shower
Hail
Light Snow Shower
Light Snow
Heavy Snow Shower
Heavy Snow
Thundery Shower
Thunder Storm
Tropical Storm
Haze
North
South
East
West
North/East
North/West
South/East
South/West
Various
North/North/East
East/North/East
East/South/East
South/South/East
South/South/West
West/South/West
West/North/West
North/North/West
East/by/North
East/by/South
North/by/East
North/by/West
NE/by/East
NE/by/north
NW/by/North
NW/by/West
SE/by/East
SE/by/South
SW/by/South
SW/by/West
South/by/East
South/by/West
West/by/North
West/by/South
L
Loading
D
Discharging
C
Canal Passage
E
Extra Port
DD
Dry Dock
DEL
Delivery
RED
Redelivery
B
Bunkering
R
Repair
CL
Tank / Hold Cleaning
STS
Ship to Ship
W
Waiting
CC
Customs Clearance
POST ws/rest/PortCall
{ "port": 100949, "reasonForCall": "D", "portCallSequence": 3, "voyage": 8807674, "eventLogs": [ { "event": "BRT", "eventLogDate": "2023-05-09T16:02:13" }, { "event": "DEP", "eventLogDate": "2023-05-09T16:02:13" }, { "event": "ARR", "eventLogDate": "2023-05-09T16:02:13" } ]}
GET ws/rest/Port?filter=rpCode(NULL)&sort=portName(ASI)
HTTP header
disablemaxlimit: YES