...
Chapter Contents:
Table of Contents | ||||||||
---|---|---|---|---|---|---|---|---|
|
Port Call
Anchor | ||||
---|---|---|---|---|
|
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
Code Block |
---|
GET
ws/rest/PortCall?filter=voyage.vessel.imoNumber(EQ)999&filter=departureFixed(EQ)false&filter=voyage.voyageHeader.voyageStatus.statusTypeCode(IN)(NOM,OPR)&filter=voyage.voyageHeader.isBudget(EQ)false&filter=voyage.voyageHeader.isTemplate(EQ)false&filter=voyage.voyageHeader.isEstimate(EQ)false&filter=voyage.voyageHeader.isUnallocated(EQ)false&filter=voyage.scenarios.scenarioCode(EQ)MASTER&filter=reasonForCall.reasonForCall(NE)DEL&filter=reasonForCall.reasonForCall(NE)RED&sort=portCallSequence(AS)
HTTP header
fields: {"voyage":{"key":"*"},"reasonForCall":{"reasonForCall":"*", "reasonForCallDesc":"*"}, "portCallSequence":"*", "port":{"portName":"*"},"eventLogs":{"eventLogDate":"*","event":{"eventCode":"*"}}} |
...
JSON Field Name | Description | Affects Dataloy VMS | Mandatory | Type | Length | Example | Client validation |
---|---|---|---|---|---|---|---|
portCall | A port call key | Yes | |||||
vesselReportType |
| Yes | String | 4 | |||
reportDateLocal | Report Date Local Time | Yes | Date | ||||
latitude | Position Latitude (Decimal Degrees) | Double | 5 | 12.575 | User input should be degrees, minutes and seconds. For example: 12° 34'5 N. Validation: if (minutes > 60) { return false; | ||
longitude | Position Longitude (Decimal Degrees) | Double | 5 | 123.76 | Same validation as for latitude | ||
eventLogs | 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"}] | |||
trueCourse | True Course | Integer | 38 | ||||
distanceSailed | Distance Sailed Since Last Report | 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 (direction) | Integer | 38 | One of the values from this list: direction | |||
averageWindForce | Wind Force. Beaufort. | Integer | 38 | 0-12 | |||
seaDirection | Sea Direction (direction) | Integer | 38 | One of the values from this list: direction | |||
averageSeaState | Sea State. Integer from 0 - 9. | Integer | 38 | 0-9 | |||
weather | Weather. weather | Integer | 38 | One of the values from this list: weather | |||
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 Board | Double | Positive decimal value |
...
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 |
Related Content
...
title | Expand to see related content |
---|
...
...
Adding port calls
For long TC out voyages you might want to make it possible to add port calls from you vessel client. This section will explain how to do that.
To insert a port call the following API call can be used
Code Block |
---|
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" }
]
} |
Port
Code Block |
---|
GET ws/rest/Port?filter=rpCode(NULL)&sort=portName(ASI)
HTTP header
disablemaxlimit: YES |
Voyage