🖍️
Dataloy VMS API Documentation
API Release 8.5
API Release 8.5
  • Dataloy VMS API
  • Dataloy Rest API
    • What is it?
    • Authentication / Authorization
    • Getting Started
    • Data Model
    • Filtering
    • Sorting
    • Pagination
    • Adjust Number of Fields to be Returned from a Request
    • Webhooks
      • Webhook example
      • Expressions Made Easy
      • Webhooks - New functionalities
    • Master data Objects
    • Attachments
    • Audit Log
  • User Guides
    • Accounting Integration API
      • Invoicing
      • Payments/Receipts
      • Voyages
      • Business Partners
      • Exchange Rates
      • Bunker Transactions
      • Actuals
      • Autopost Invoices
      • Accruals
    • Schedule API
    • Bunker Order Integration API
    • Service Order Integration API
    • Vessel Report
      • Release 8.5
      • Release 8.0
      • Release 7.3 - 7.12
      • Release 7.0 - 7.2
      • Release 6.29 - 6.46
      • Legacy version (6.26 - 6.28)
      • Vessel report master data
    • Bunker Consumption API
    • Left join in API queries
    • Enterprise functionalities
      • Versioning
      • Endpoint access control
      • Data access control via target object
      • Data access control via target object and security role
      • Data access control at object level
      • Fields access control
      • Alert Scripts
      • Websockets
      • Bulk Deletion
      • Copy objects
      • OR and AND operators in API queries
      • Sub queries
      • XML Transformation
      • Expressions
      • Bulk Update
Powered by GitBook
On this page
  • Vessel Report API Process
  • Alerts
  • Noon report
  • Arrival report
  • In Port Report
  • Departure Report
  • Example Messages
  • Consumption Breakdown
  • Weather Data
  • Direction
  • Reason For Call
  • Dataloy Vessel Code
  • Dataloy Port ID

Was this helpful?

Export as PDF
  1. User Guides
  2. Vessel Report

Legacy version (6.26 - 6.28)

PreviousRelease 6.29 - 6.46NextVessel report master data

Was this helpful?

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:

Vessel Report API Process

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).

  • ed = event date

  • ec = event code.

Remarks will be connected to the Position Report. To send remarks requires:

Alerts

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.

Noon report

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

Arrival report

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

In Port Report

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

Departure Report

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

Example Messages

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

Consumption Breakdown

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.

Weather Data

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

Direction

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

Reason For Call

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 Code

Dataloy Port ID

Events are added and retrieved from and can be used in a JSON message. Event fields in the JSON message is shortened:

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 ).

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,

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)

Dataloy Vessel Codes can be found by using the .

Dataloy Port ID's can be found be using the .

reportTypeCode
vesselCode
reportDateLocal
latitude
longitude
portId
arrival
berthed
departure
trueCourse
distanceSailed
hoursInService
distanceToNextPort
speedMadeGood
windDirectionId
averageWindForce
seaDirectionId
averageSeaState
bhpMainEngineIndicatedRpm
dailyFo
dailyDo
dailyFl
dailyDl
dailyFw
robFo
robDo
robFl
robDl
robFw
genericRemark
reportTypeCode
vesselCode
portId
reportDateLocal
arrival
berthed
departure
distanceSailedSinceDeparture
distanceSailed
hoursStoppages
hoursInService
speedMadeGood
draftAft
draftForward
dailyFo
dailyDo
dailyFl
dailyDl
dailyFw
robFo
robDo
robFl
robDl
robFw
genericRemark
reportTypeCode
vesselCode
portId
reportDateLocal
berthed
departure
hoursInService
weatherId
windDirectionId
averageWindForce
genericRemark
reportTypeCode
vesselCode
portId
reportDateLocal
departure
nextPortId
arrival
distanceToNextPort
draftAft
draftForward
robFo
robDo
robFl
robDl
robFw
foBunkered
flBunkered
doBunkered
dlBunkered
genericRemark
{
    "remarks": [],
    "events": [
        {
            "ed": "2013-12-24T00:00:00",
            "ec": "VR05"
        },
        {
            "ed": "2013-12-24T00:00:00",
            "ec": "VR10"
        }
    ],
    "reportTypeCode": "ARR",
    "vesselCode": "14",
    "portId": "104419",
    "reportDateLocal": "2013-12-24T00:00:00",
    "arrival": "2013-12-24T00:00:00",
    "berthed": "2013-12-24T00:00:00",
    "departure": "2013-12-24T00:00:00",
    "distanceSailed": "10",
    "distanceSailedSinceDeparture": "10",
    "hoursInService": "10",
    "hoursStoppages": "10",
    "speedMadeGood": "10",
    "draftAft": "10",
    "draftForward": "10",
    "dailyFo": "10",
    "dailyDo": "10",
    "dailyFl": "10",
    "dailyDl": "10",
    "dailyFw": "10",
    "robFo": "10",
    "robDo": "10",
    "robFl": "10",
    "robDl": "10",
    "robFw": "10",
    "genericRemark": "Remark"
}
{
    "events": [],
    "reportTypeCode": "NOON",
    "vesselCode": "14",
    "latitude": 10.17,
    "longitude": 10.17,
    "portId": "104419",
    "reportDateLocal": "2013-12-24T00:00:00",
    "arrival": "2013-12-24T00:00:00",
    "berthed": "2013-12-24T00:00:00",
    "departure": "2013-12-24T00:00:00",
    "trueCourse": "10",
    "distanceSailed": "10",
    "hoursInService": "10",
    "distanceToNextPort": "10",
    "speedMadeGood": "10",
    "windDirectionId": "911638",
    "averageWindForce": "0",
    "seaDirectionId": "911638",
    "averageSeaState": "1",
    "bhpMainEngineIndicatedRpm": "10",
    "dailyFo": "10",
    "dailyDo": "10",
    "dailyFl": "10",
    "dailyDl": "10",
    "dailyFw": "10",
    "robFo": "10",
    "robDo": "10",
    "robFl": "10",
    "robDl": "10",
    "robFw": "10",
    "genericRemark": "Remark"
}
{
    "remarks": [
        {
            "id": "70495526",
            "r": "100"
        },
        {
            "id": "70495527",
            "r": "100"
        },
        {
            "id": "70495528",
            "r": "100"
        }
    ],
    "events": [
        {
            "ed": "2013-12-24T00:00:00",
            "ec": "VR60"
        }
    ],
    "reportTypeCode": "PORT",
    "vesselCode": "14",
    "portId": "104419",
    "reportDateLocal": "2013-12-24T00:00:00",
    "berthed": "2013-12-24T00:00:00",
    "departure": "2013-12-24T00:00:00",
    "hoursInService": "20",
    "weatherId": "950936",
    "windDirectionId": "913903",
    "averageWindForce": "1",
    "genericRemark": "Remark"
}
950926
950927
950928
950929
950930
950931
950932
950933
950934
950935
950936
950937
950938
950939
950940
950941
950942
950943
950944
950945
950946
950947
950948
950949
950950
950951
911636
911637
911638
911639
911640
911641
911642
911643
913753
913902
913903
913904
913905
913906
913907
913908
913909
916765
916766
916767
916768
916769
916770
916771
916772
916773
916774
916775
916776
916777
916778
916779
916780
Master Data
contact Dataloy
contact Dataloy
API version 2.0.0
Vessel Code Resource
Port Resource
Vessel Report API Process
Alerts
Noon report
Arrival report
In Port Report
Departure Report
Example Messages
Consumption Breakdown
Weather Data
Direction
Reason For Call
Dataloy Vessel Code
Dataloy Port ID
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992
924581992