Voyages

Prerequisites

No prerequisites.

Integration Set-Up

Accounting systems often require voyage related data before transferring accounting related transactions. Set up a scheduled task and use the request under Data Transaction to gather all voyages that has been modified since the last time a scheduled task was run.

Test Data

Modify some existing voyages in the Booking and Operations module for testing, for example, changing a date in the schedule (note: changing dates will also affect the schedule for other voyages).

Data Transaction

Get new voyages using webhooks

To get new voyages in Webhooks the following subscription can be created:

{
"eventType": "U",
"user":
"objectType": "VoyageHeader",
"expression": "{"type":"group","id":"root","combine":"OR","items":[{"type":"group","id":"1779183625231-nrms8uv","combine":"AND","items":[{"type":"condition","condition":{"id":"1779183625231-ctl7zhz","operator":"=","leftKind":"field","leftField":{"path":["voyageStatus","statusTypeCode"],"type":"object","arrayFilters":[]},"leftSource":"previous","rightKind":"literal","rightValue":"EST"}},{"type":"condition","condition":{"id":"1779183710793-qsn8j3m","operator":"=","leftKind":"field","leftField":{"path":["voyageStatus","statusTypeCode"],"type":"object","arrayFilters":[]},"leftSource":"current","rightKind":"literal","rightValue":"NOM"}}]},{"type":"group","id":"1779183632027-tr8y79a","combine":"AND","items":[{"type":"condition","condition":{"id":"1779183632027-z9d3dbj","operator":"null","leftKind":"field","leftField":{"path":["referenceNo"],"type":"string","arrayFilters":[]},"leftSource":"previous","rightKind":"literal","rightValue":null}},{"type":"condition","condition":{"id":"1779183752798-06s1k61","operator":"notNull","leftKind":"field","leftField":{"path":["referenceNo"],"type":"string","arrayFilters":[]},"leftSource":"current","rightKind":"literal","rightValue":null}},{"type":"condition","condition":{"id":"1779183769572-kl63bpk","operator":"=","leftKind":"field","leftField":{"path":["voyageStatus","statusTypeCode"],"type":"object","arrayFilters":[]},"leftSource":"current","rightKind":"literal","rightValue":"NOM"}}]}],"version":2}",
"url":
}

To get updated for all changes on a voyage the following webhook subscription can be created:

{
"eventType": "U",
"user":
"objectType": "VoyageHeader",
"url":
}

Get all fixed voyages modified since given date

To extract all fixed voyages from Dataloy VMS that has been modified since a given date, use request below in conjunction with the base URL:

GET /VoyageHeader?filter=modifiedDate(GTE)2014-01-01T12:30:00

Post Transaction

No post transaction is required.