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:
...
Code Block | ||
---|---|---|
| ||
PUT request on /PortCall/{key} { "agencyAppointmentStatus": "CAN" } |
...
Anchor | ||||
---|---|---|---|---|
|
...
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 serviceresource: 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 | ||||
---|---|---|---|---|
|
Business Partners
Prerequisites
Synchronization of business partners between Dataloy VMS and the applicable agency accounting system is required before transferring port call (or agent information) accounting related transactions. To synchronize business partner updates between systems, decide which system is to be the Master System (where the business partners will be updated). The Master System will then send updated business partner data to the other system.
Integration Set-Up
- Dataloy VMS is used as master: Set up up a scheduled task and use the request under Data Transaction (below) to gather all business partners data having been modified since the last time a scheduled task was run.
- Dataloy VMS is is not used used as master: Use the requests under Data Transaction (below) to insert and update business the business partners in Dataloy VMS.
Data Transaction
Dataloy VMS as a Master master for Business Partners
...
business partners
Extract the business partners whose data has been modified since a selected date from Dataloy VMS using the following request in conjunction with the base URL:
Code Block title Get business partner information GET /BusinessPartner?filter=modifiedDate(GTE)20152014-01-01T12:30:00
- Set up a scheduled task and gather all business partners voyages that have been modified since the last time a scheduled task was run.
Other system as master Master for Business Partners
Check if relevant business partners partner/s is/are already existing in Dataloy VMS by using the following request in conjunction with the base URL:
Code Block title Get business partner by key GET /BusinessPartner?filter=businessPartnerCode(EQ)99999
- If the business partner is
- already entered in Dataloy VMS. For versions prior to API 3.0:
Update Business Partner:
Code Block title Update Business Partner PUT /BusinessPartner/{BusinessPartner key} { "businessPartnerName": "Updated Test Name" }
Update Address:
Code Block title Update Address PUT /Address/{Address key} { "address1": "Updated address" }
Update Bank:
Code Block title Update Bank PUT /Bank/{Bank key} { "swiftAddress": "Updated Swift address" }
Update Bank Account:
Code Block title Update Bank Account PUT /BankAccount/{Bank account key} { "bankAccountNo": "UpdatedNumber" }
Update Contact Information:
- already entered in Dataloy VMS. For versions prior to API 3.0:
Code Block title Update Contact Info PUT /ContactInfo/{ContactInfo key} { "email": "updated@emailaddress.com" }
Link an existing Bank Account
to a to the Business Partner (new
in in API version 2.0.0).
Code Block POST /BusinessPartner/{business partner key}/BankAccount/{bank account key}/link
Unlink an existing Bank Account to a Business Partner (new
in in API version 2.0.0).
Code Block POST /BusinessPartner/{business partner key}/BankAccount/{bank account key}/unlink
not already entered in Dataloy VMS
: . For versions from API 3.0:
PUT the BusinessPartner object:
Code Block put /BusinessPartner { "key":1111111, "
bankNamebusinessPartnerName": "
BPTest
bankName", "
abaNumberbusinessPartnerCode": "
1111123456789",
"
chipbusinessPartnerSort": "
2222TESTNAME", "
swiftAddresscompanyRegistrationNo": "
3333"
}123456789",
"
businessPartnerNamebusinessPartnerType": "
Test NameC", "
businessPartnerCodebankAccounts":[
"123456789",{
"companyRegistrationNo":"
businessPartnerTypekey":
"C",
"bankAccounts":[
{
222222, "iban":"9754", "bankAccountNo":"6523", "bank": 1033615, "currency": 400132 } ], "addresses": [ {
"key":333333, "country": "NL", "address1": "Street Name 54", "address2": "5th floor", "address3": "", "city": "Amsterdam", "postalCode": "1000 AA" } ], "contactInfo": [ { "key":444444, "email": "test@test.com", "faxNo": "55555555", "mobileNo": "66666666", "phoneNo": "77777777", "telexNo": "88888888" } ] }
- not entered in Dataloy VMS:
POST the new business partner. Note: Required fields: businessPartnerName, businessPartnerCode, businessPartnerSort.
Code Block title Insert a new business partner POST /BusinessPartner { "businessPartnerName": "Test Name", "businessPartnerCode": "123456789", "businessPartnerSort": "TESTNAME", "companyRegistrationNo": "123456789", "businessPartnerType": "C", "bankAccounts":[ { "iban":"9754", "bankAccountNo":"6523", "bank": { "bankName":"BP bank", "abaNumber":"1111", "chip":"2222", "swiftAddress":"42341" }, "currency": 400132 } ], "addresses": [ { "country": "NL", "address1": "Street Name 54", "address2": "5th floor", "address3": "", "city": "Amsterdam", "postalCode": "1000 AA" } ], "contactInfo": [ { "email": "test@test.com", "faxNo": "55555555", "mobileNo": "66666666", "phoneNo": "77777777", "telexNo": "88888888" } ] }
More Info: /BusinessPartner, /Address, /ContactInfo, /BankAccount, /Bank
- not entered in Dataloy VMS:
Insert banks for bank accounts related to the business partner into the master system:
title | Insert a new bank |
---|
POST the new business partner. Note: Required fields: businessPartnerName, businessPartnerCode, businessPartnerSort.
title | Insert a new business partner |
---|
More Info: /BusinessPartner, /Address, /ContactInfo, /BankAccount, /Bank.
Test Data
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 | ||
---|---|---|
| ||
|