Versions Compared

Old Version 11

changes.mady.by.user Karl-André Dalby

Saved on

compared with

New Version 12

changes.mady.by.user Karl-André Dalby

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

From 6.29

...

Updates ETD and ETB in Schedule

Date
JSON Field Name
Description
Affects Dataloy VMS
MandatoryTypeLengthExampleClient validation
portCall
A port call key
Yes



vesselReportType
  • Vessel Report Type
  • Value = NOON for Noon Report

YesString4

reportDateLocal
Report Date Local Time
YesDate


latitude
Position Latitude (Decimal Degrees)

Double5
longitude
Position Longitude (Decimal Degress)Double5
eta
Estimated Time of ArrivalUpdates ETA in Schedule.Date
eventLogs

Array of EventLog

Add Departure Time as an Event Log with "DEP" event code,

Add Berthed Time as an Event Log with "BRT" event code

12.575

User input should be degrees, minutes and seconds. For example: 12° 34'5 N

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;

longitude
Position Longitude (Decimal Degrees)

Double5123.76Same validation as for latitude
eventLogs

Array of EventLog.

For noon report this can be estimated time of arrival, berthing and departure.

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"}]


trueCourse
True Course

Integer38

distanceSailed
Distance Sailed Since Last ReportUpdates the port call's actual distanceReport

Double

Positive decimal value
hoursInService
Hours in Service Since Last Report

Double

Positive decimal value
distanceToNextPort
Distance To Go

Double

Positive decimal value
speedMadeGood
Speed Made Good

Double

Positive decimal value
windDirection
Wind Direction (more detailsdirection)

Integer38

averageWindForce
Wind Force. Beaufort.

Integer38

seaDirection
Sea Direction (more detailsdirection)


Integer38

averageSeaState
Sea State. Integer from 0 - 9.

Integer38

bhpMainEngineIndicatedRpm
Main Engine RPM Since Last Report

Double

Positive decimal value
dailyFo
Daily Fuel Oil Consumption

Double

Positive decimal value
dailyDo
Daily Diesel Oil Consumption

Double

Positive decimal value
dailyFl
Daily Fuel Oil Low Sulphur Consumption

Double

Positive decimal value
dailyDl
Daily Diesel Oil Low Sulphur Consumption

Double

Positive decimal value
dailyFw
Daily Net Fresh Water Consumption

Double

Positive decimal value
robFo
Fuel Oil Remaining on Board (FO RoB)Updates FO arrival RoB of the Port Call
Double

Positive decimal value
robDo
Diesel Oil Remaining on Board (DO RoB)Updates DO arrival RoB of the Port Call
Double

Positive decimal value
robFl
Fuel Oil Low Sulphur Remaining on Board (FO LS RoB)Updates FO LS arrival RoB of the Port Call
Double

Positive decimal value
robDl
Diesel Oil Low Sulphur Remaining on Board (DO LS RoB)Updates DO LS arrival RoB of the Port Call
Double

Positive decimal value
robFw
Fresh Water Remaining on BoardDouble

Double

Positive decimal value

Arrival report 

DoubleDouble
JSON Field Name
Description
Affects Dataloy VMS
MandatoryTypeLengthExampleClient validation
portCall
A port call key
YesInteger


vesselReportType
Vessel Report Type
Value = ARR for Arrival Report.
YesString4

reportDateLocal
Report Date Local Time
YesDate


eventLogs

Array of EventLog

Add Arrival Time as an Event Log with "ARR" event code,

Add Departure Time as an Event Log with "DEP" event code,

Add Berthed Time as an Event Log with "BRT" event code.

For departure report this can be time of arrival, estimated time of berthing and departure.

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

YesArray of EventLogs
distanceSailedSinceDeparture
Total Distance Sailed Since DepartureUpdates Miles in Schedule.

[{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"}]


distanceSailed
Distance Sailed Since Last Report departureUpdates actual distance sailed
Double
hoursStoppages
Hours StoppagesUpdates Days Stoppages (see the Perfomance tab in Booking and Operations).

Positive decimal value
hoursStoppages
Hours Stoppages

Double

Positive decimal value
hoursInService
Hours in Service

Double

Positive decimal value
speedMadeGood
Speed Made Good Since Last Report

Double

Positive decimal value
draftAft
Draft Aft

Double

Positive decimal value
draftForward
Draft Forward

Double

Positive decimal value
dailyFo
Daily Fuel Oil Consumption


Double

Positive decimal value
dailyDo
Daily Diesel Oil Consumption

Double

Positive decimal value
dailyFl
Daily Fuel Oil Low Sulphur Consumption

Double

Positive decimal value
dailyDl
Daily Diesel Oil Low Sulphur Consumption

Double

Positive decimal value
dailyFw
Daily Net Fresh Water consumption

Double

Positive decimal value
robFo
Fuel Oil Remaining on Board (FO RoB)Updates and fixes Fuel Oil Remaining on Board (FO RoB) Arrival. 
Double

Positive decimal value
robDo
Diesel Oil Remaining on Board (DO RoB)Updates and fixes Diesel Oil Remaining on Board (DO RoB) Arrival.
Double

Positive decimal value
robFl
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
robDl
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
robFw
Fresh Water remaining on board

DoubleDouble

Positive decimal value

In Port Report

Updates and fixes Berthed Time and Date

Updates ETD in Schedule

JSON Field Name
Description
Affects Dataloy VMS
MandatoryTypeLengthExampleClient validation
portCall
A port call key
YesInteger


vesselReportType

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.YesString4
reportDateLocal
Report Date Local TimeYesDate
eventLogs

Array of EventLog

Add Estimated Departure Time as an Event Log with "DEP" event code,

Add Estimated Berthed Time as an Event Log with "BRT" event code

YesDate4

reportDateLocal
Report Date Local Time
YesDate


eventLogs

Array of EventLog.

For in port report this can be time of berthing and estimated time of departure.

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

YesDate

[{eventLogDate: "2023-01-03T03:34:00.000Z", event: "BRT"},

{eventLogDate: "2023-01-03T03:34:00.000Z", event: "DEP"}]


hoursInService
Hours in Service

Double

Positive decimal value
weather
Weather. More Details. weather

Integer38

windDirection
Wind Direction. More Details. direction 

Integer38

averageWindForce
Average Wind Force. Beaufort.

Integer38
0-12


Departure Report

JSON Field Name
Description
Affects Dataloy VMS
MandatoryTypeLength
portCall
A port call key
Yes

vesselReportType
Vessel Report Type.
Value = DEP for Departure Report.
YesString4
reportDateLocal
Report Date Local Time
YesDate
eventLogs

Array of EventLog

Add Departure Time as an Event Log with "DEP" event code


Updates and fixes Departure Time in Schedule. 

YesDate
distanceToNextPort
Distance To Next Port

Double
draftAft
Draft Aft

Double
draftForward
Draft Forward

Double
robFo
Fuel Oil Remaining on Board (FO RoB)Updates and fixes Fuel Oil Remaining on Board (FO RoB) departure.
Double
robDo
Diesel Oil Remaining on Board (DO RoB)Updates and fixes Diesel Oil Remaining on Board (DO RoB) departure.
Double
robFl
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
robDl
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
robFw
Fresh Water Remaining on Board

Double
foBunkered

Bunkered Fuel Oil
Input Exact Figure According to BDR

Updates Fuel Oil bunkered for departure port call.
Double
flBunkered

Bunkered Fuel Oil Low Sulphur
Input exact figure according to the BDR

Updates Fuel Oil Low Sulphur bunkered for departure port call.
Double
doBunkered

Bunkered Diesel Oil
Input exact figure according to the BDR

Updates Diesel Oil bunkered for departure port call.
Double
dlBunkered

Bunkered Diesel Oil Low Sulphur
Input exact figure according to the BDR

Updates Diesel Oil Low Sulphur bunkered for departure port call.
Double

...

The following fields can be added for consumption breakdown

Main Engine - Fuel OilInserted to position report.
Main Engine - Fuel Oil Low SulphurInserted to position report.
Main Engine - Diesel OilInserted to position report.
Main Engine - Diesel Oil Low SulphurInserted to position report.
Auxiliary - Fuel Oil At SeaInserted to position report.
Auxiliary - Fuel Oil Low Sulphur At SeaInserted to position report.
Auxiliary - Diesel Oil At SeaInserted to position report.
Auxiliary - Diesel Oil Low Sulphur At SeaInserted to position report.Inserted to position report.
Boilers - Fuel Oil IdleInserted to position report.
Boilers - Fuel Oil Low Sulphur IdleInserted to position report.
Boilers - Diesel Oil IdleInserted to position report.
Boilers - Diesel Oil Low Sulphur IdleInserted to position report.
Boilers - Fuel Oil WorkingInserted to position report.
Boilers - Fuel Oil Low Sulphur WorkingInserted to position report.
Boilers - Diesel Oil WorkingInserted to position report.
Boilers - Diesel Oil Low Sulphur WorkingInserted to position report.
Generators - Fuel Oil At SeaInserted to position report.
Generators - Fuel Oil Low Sulphur At SeaInserted to position report.
Generators - Diesel Oil At SeaInserted to position report.
Generators - Diesel Oil Low Sulphur At SeaInserted to position report.
Cleaning - Fuel OilInserted to position report.
Cleaning - Fuel Oil Low SulphurInserted to position report.
Cleaning - Diesel OilInserted to position report.
Cleaning - Diesel Oil Low SulphurInserted to position report.
Heating - Fuel Oil ConsumptionInserted to position report.
Heating - Fuel Oil Low SulphurInserted to position report.
Heating - Diesel OilInserted to position report.
Heating - Diesel Oil Low SulphurInserted to position report.

...

Dataloy Events can be found by using the Event Resource.




Top
New Vessel Report APIBack

Related Content

Expand
titleExpand to see related content


Wiki Markup
{dynamiccontentbylabel:showLabels=false|showSpace=false}


...