...
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 | 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 |
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" }
]
} |
Field explanation:
Port
A port key. Get a list of all ports with the below API call. There are over 10000 ports. Please keep the number of requests to this endpoint as low as possible with caching. We do add new ports so if the vessel needs a newly added port it must be possible to update the cache, this will not happen often.
GET ws/rest/Port?filter=rpCode(NULL)&sort=portName(ASI)
HTTP header
disablemaxlimit: YES
Reason for call
Port Call Sequence
Should be port call sequence from last port call + 1. The port call sequence is returned in this API call to get port calls.
Voyage
Event Logs
There needs to be one eventLog for ARR (arrival), BRT (berthing), DEP (departure). Set the dates to todays date, they will then be calculated by the server. After inserting the port call, get the list of port calls again to get the ETA, ETB and ETD calculated by the server.