Short Description
...
More information:/PortCall.
Post Transaction
When a port call is successfully transferred to an agency system, the port call status must be updated to Appointed in Dataloy VMS. This is done in a PUT request:
...
More information:/PortCall.
Post Transaction
When an updated port call has been successfully handled in the agency system, the port call status must be updated to Updated in Dataloy VMS. This is done in a PUT request:
...
| Property | Type | Description | Comments |
|---|---|---|---|
| portCall | /PortCall | Identifies Port Call | If a disbursement account (DA) is inserted into Dataloy at a later stage, the port call identifier is necessary to identify which port call to insert the DA on. |
| agent | /BusinessPartner | Agent of the Port Call | Dataloy VMS agent codes are to be retrieved from Dataloy VMS and can be retrieved through the BusinessPartner resource: BusinessPartner?filter=businessPartnerType.businessPartnerType(EQ)A |
| voyage | /Voyage | The Voyage the Port Call Belongs to | |
| vessel | /Vessel | The Vessel the voyage Belongs to | |
| company | /Company | The Company of Responsible for the Voyage | |
| port | /Port | Port of the Port Call | |
| reasonForCall | /ReasonForCall | Reason for Call | |
| cargos | /Cargo | Cargoes on the Voyage | |
| commodity | /Commodity | Commodity of the Cargo | |
| eventLogs | /EventLog | Information when the Vessel Arrived, Berthed and Departed from the port |
| Anchor | ||||
|---|---|---|---|---|
|
...
Create test data for transferring business partners from Dataloy VMS by updating Business Partners in Master Data.
Post Transaction
No post transaction is required.
...
| Port Call Status Code | Port Call Status Description | Description |
|---|---|---|
| SNT | Sent | Port Call (Appointment) has been sent from Dataloy VMS. |
| APP | Appointed | Port Call (Appointment) has been appointed in Dataloy VMS and agency system. |
| UPSNT | Update Sent | Port Call (Appointment) has been updated in Dataloy VMS. |
| UPD | Updated | Port Call (appointment) has been updated in Dataloy VMS and agency system. |
| CASNT | Cancellation Sent | Port Call (Appointment) has been cancelled in Dataloy VMS. |
| CAN | Cancelled | Port Call (Appointment) has been cancelled in Dataloy VMS and agency system. |
| FLD | Failed | Port Call (appointment) has failed in the agency system. |
Webhooks
To gather data from Dataloy, instead to polling, is possible to use Webhooks to get notifications when there are changes. To have more info regarding Webhooks
Related Content
| Expand | ||
|---|---|---|
| ||
|