Page Comparison

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

From 6.28

Short Description

Inserting a position into Dataloy Vessel Report System (Dataloy VRS) 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.VMS updates the schedule, bunkers etc. The new Vessel Report API requires a proper internet connection. See /wiki/spaces/VMSINT/pages/923414876 for the documentation about Dataloy Vessel Report System which does not require proper internet connection.

Chapter Contents: 

Long Description

...

All fields will get inserted to a Position Report.

Position Report API Process

...

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:

...

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:

...

IMPORTANT: Property Settings is handled in: Master Data > Dataloy Properties.

Properties

Base URL

The Vessel Position Report URL:

Base URL + ws/rest/VesselReportPositionReport

Noon report

portCall

reportTypeCode

vesselCode

reportDateLocal

latitude

longitude

portId

arrival

eta

berthedeventLogs

departure

trueCourse

distanceSailed

hoursInService

distanceToNextPort

speedMadeGood

windDirectionIdwindDirection

averageWindForce

seaDirectionIdseaDirection

averageSeaState

bhpMainEngineIndicatedRpm

dailyFo

dailyDo

dailyFl

dailyDl

dailyFw

robFo

robDo

robFl

robDl

robFw

genericRemark???

Arrival report 

portCall

reportTypeCode

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

In Port Report

...

...

...

reportTypeCode

...

Vessel Report Type
Value = PORT for In Port Report.

...

vesselCode

...

portId

...

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.

...

reportDateLocal

...

berthed

...

departure

...

hoursInService

...

weatherId

...

windDirectionId

...

averageWindForce

...

genericRemark

...

...

...

reportTypeCode

...

vesselCode

...

portId

...

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.

...

reportDateLocal

...

departure

...

nextPortId

...

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.

...

arrival

...

distanceToNextPort

...

draftAft

...

draftForward

...

robFo

...

robDo

...

robFl

...

robDl

...

robFw

...

foBunkered

...

Bunkered Fuel Oil
Input Exact Figure According to BDR

...

flBunkered

...

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

...

doBunkered

...

Bunkered Diesel Oil
Input exact figure according to the BDR

...

dlBunkered

...

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

...

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

...

...

reportDateLocal

eta

eventLogs

distanceSailedSinceDeparture

distanceSailed

hoursStoppages

hoursInService

speedMadeGood

draftAft

draftForward

dailyFo

dailyDo

dailyFl

dailyDl

dailyFw

robFo

robDo

robFl

robDl

robFw

genericRemark???

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",
			"eceventLogs":"VR20"
		},
		{
			"ed [{"eventLogDate":"2013-12-24T00:00:00", 			"ecevent":{"VR25ARR"
		}}, 		{
			{"edeventLogDate":"2013-12-24T00:00:00", 			"ecevent":{"VR30BRT"
		}}, 		{
			"edeventLogDate":"2013-12-24T00:00:00", 			"ecevent":{"VR40DEP"
		}}],
		{
			"ed":"2013-12-24T00:00:00"distanceSailed":"10",
	"distanceSailedSinceDeparture":"10",
			"echoursInService":"VR4510",
		},
		{
			"ed":"2013-12-24T00:00:00",
			"ec":"VR50"
		},
		{
			"ed":"2013-12-24T00:00:00",
			"ec":"VR55"
		}
	],
	"reportTypeCode":"DEP"hoursStoppages":"10",
	"speedMadeGood":"10",
	"draftAft":"10",
	"draftForward":"10",
	"dailyFo":"10",
	"dailyDo":"10",
	"vesselCodedailyFl":"1410",
	"portIddailyDl":"10441910",
	"reportDateLocaldailyFw":"2013-12-24T00:00:0010",
	"departurerobFo":"2013-12-24T00:00:0010",
	"nextPortIdrobDo":"10441910",
	"arrivalrobFl":"2013-12-24T00:00:0010",
	"distanceToNextPortrobDl":"10",
	"draftAftrobFw":"10",
	//"draftForwardgenericRemark":"10",Remark"
}

 {
	"robForeportTypeCode":"10DEP",
	"robDoportCall":{"10key": 1009999},
	"robFlreportDateLocal":"102013-12-24T00:00:00",
	"robDleventLogs":"10",
	"robFw [{"eventLogDate":"102013-12-24T00:00:00", 	"foBunkeredevent":{"10DEP"}}, 	{"flBunkeredeventLogDate":"102013-12-24T00:00:00", 	"doBunkeredevent":{"10ARR"}}],
	"dlBunkereddistanceToNextPort":"10",
	"genericRemarkdraftAft":"Remark"
}

{10",
	"remarksdraftForward":["10",
	]"robFo":"10",
	"eventsrobDo":[
	]"10",
	"reportTypeCoderobFl":"NOON10",
	"vesselCoderobDl":"1410",
	"latituderobFw":"10.17",
	//"longitudefoBunkered":"10.17",
	//"portIdflBunkered":"10441910",
	//"reportDateLocaldoBunkered":"2013-12-24T00:00:0010",
	//"arrivaldlBunkered":"2013-12-24T00:00:0010",
	//"berthedgenericRemark":"2013-12-24T00:00:00",Remark"
}

{
	"departurereportTypeCode":"2013-12-24T00:00:00NOON",
	"trueCourseportCall":{"10key": 1009999},
	"distanceSailedlatitude":"10".17,
	"hoursInServicelongitude":"10".17,
	"distanceToNextPortreportDateLocal":"102013-12-24T00:00:00",
	"speedMadeGoodeventLogs":"10",
	"windDirectionId [{"eventLogDate":"9116382013-12-24T00:00:00", 	"averageWindForceeventCode":{"0ARR"}}, 
			{"seaDirectionIdeventLogDate":"9116382013-12-24T00:00:00", 	"averageSeaStateevent":{"1BRT"}}, 	{"bhpMainEngineIndicatedRpmeventLogDate":"102013-12-24T00:00:00", 	"dailyFoevent":{"10DEP"}}],
	"dailyDotrueCourse":"10",
	"dailyFldistanceSailed":"10",
	"dailyDlhoursInService":"10",
	"dailyFwdistanceToNextPort":"10",
	"robFospeedMadeGood":"10",
	"robDowindDirectionId":"10911638",
	"robFlaverageWindForce":"100",
	"robDlseaDirectionId":"10911638",
	"robFwaverageSeaState":"101",
	"genericRemarkbhpMainEngineIndicatedRpm":""
}

{10",
	"remarksdailyFo":[
		{"10",
			"iddailyDo":"7049552610",
			"rdailyFl":"10010"
		},
		{
			"id"dailyDl":"7049552710",
			"rdailyFw":"10010"
		},
		{
			"idrobFo":"7049552810",
			"rrobDo":"100"
		}
	]10",
	"eventsrobFl":[
		{
		"10",
	"edrobDl":"2013-12-24T00:00:0010",
			"ecrobFw":"VR60"
		}
	]10",
	//"reportTypeCodegenericRemark":"PORT","
}

{
	"vesselCodereportTypeCode":"14PORT",
	"portIdportCall":{"104419key": 1009999},
	"reportDateLocal":"2013-12-24T00:00:00",
	"berthedeventLogs": [{"eventLogDate":"2013-12-24T00:00:00", "event":{"BRT"}}, 	{"departureeventLogDate":"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

Weather Data

When inserting weather data, use the ID from the Weather Data table:

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

Direction

When inserting direction, use the ID from the Direction Table:

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

Reason For Call

Anchor
reasonForCall reasonForCall

...

Dataloy

...

Event Code

Dataloy Vessel Codes Events can be found by using the Vessel Code Event Resource.

Dataloy Port ID

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

Top
Back

Related Content

{dynamiccontentbylabel:showLabels=false|showSpace=false}

...