Page Comparison

From 6.29

...

Position Report API Process

• using Events EventLogs (if there is an event 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:

...

The following properties are needed to add an EventLog

• eventLogDate = event date
• ec event = event code.code 

Remarks will be connected to the Position Report. The Position Report needs to be sent first, then Remarks can be added in a different call. To send remarks, it 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

Alerts can be triggered either:

• when reports are inserted to Dataloy VMS
• or a report is failing.

...

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.

...

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.

...

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

...

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

...

• remark = your comment
• source = id of position report

Base URL

The Position Report URL:

Base URL + ws/rest/PositionReport

The Remark URL

Base URL + ws/rest/Remark

Noon report

portCall

reportTypeCode

reportDateLocal

latitude

longitude

eta

eventLogs

trueCourse

distanceSailed

hoursInService

distanceToNextPort

speedMadeGood

windDirection

averageWindForce

seaDirection

averageSeaState

bhpMainEngineIndicatedRpm

dailyFo

dailyDo

dailyFl

dailyDl

dailyFw

robFo

robDo

robFl

robDl

robFw

genericRemark???

Arrival report 

portCall

reportTypeCode

reportDateLocal

eta

eventLogs

distanceSailedSinceDeparture

distanceSailed

hoursStoppages

hoursInService

speedMadeGood

draftAft

draftForward

dailyFo

dailyDo

dailyFl

dailyDl

dailyFw

robFo

robDo

robFl

robDl

robFw

genericRemark???

robFw

In Port Report

portCall

reportTypeCode

reportDateLocal

eventLogs

hoursInService

weather

windDirection

averageWindForce

genericRemark???

Departure Report

portCall

reportTypeCode

reportDateLocal

eventLogs

eta

distanceToNextPort

draftAft

draftForward

robFo

robDo

robFl

robDl

robFw

foBunkered???

flBunkered

doBunkered

dlBunkered????

genericRemark????

Example Messages

...

{
	"reportTypeCode":"ARR",
	"portCall":{"key": 1009999},
	"reportDateLocal":"2013-12-24T00:00:00",
	"eventLogs": [{"eventLogDate":"2013-12-24T00:00:00", "event":{"ARR"}}, 
			{"eventLogDate":"2013-12-24T00:00:00", "event":{"BRT"}}, {"eventLogDate":"2013-12-24T00:00:00", "event":{"DEP"}}],
	"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"
}

 {
	"reportTypeCode":"DEP",
	"portCall":{"key": 1009999},
	"reportDateLocal":"2013-12-24T00:00:00",
	"eventLogs": [{"eventLogDate":"2013-12-24T00:00:00", "event":{"DEP"}}, {"eventLogDate":"2013-12-24T00:00:00", "event":{"ARR"}}],
	"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"
}

{
	"reportTypeCode":"NOON",
	"portCall":{"key": 1009999},
	"latitude":10.17,
	"longitude":10.17,
	"reportDateLocal":"2013-12-24T00:00:00",
	"eventLogs": [{"eventLogDate":"2013-12-24T00:00:00", "eventCode":{"ARR"}}, 
			{"eventLogDate":"2013-12-24T00:00:00", "event":{"BRT"}}, {"eventLogDate":"2013-12-24T00:00:00", "event":{"DEP"}}],
	"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":""
}

{
	"reportTypeCode":"PORT",
	"portCall":{"key": 1009999},
	"reportDateLocal":"2013-12-24T00:00:00",
	"eventLogs": [{"eventLogDate":"2013-12-24T00:00:00", "event":{"BRT"}}, {"eventLogDate":"2013-12-24T00:00:00", "event":{"DEP"}}],
	"hoursInService":"20",
	"weatherId":"950936",
	"windDirectionId":"913903",
	"averageWindForce":"1",
	//"genericRemark":"Remark"
}

Consumption Breakdown

The following fields can be added for consumption breakdown

...