Short Description
This resource makes it possible to enables POST and GET schedules in Dataloy VMS. This is a A simple first version that will insert a schedule without doing making any calculations in Dataloy, users the VMS. The schedules should not edit these schedules be edited in the VMS as they will then be recalculated.
Chapter Contents:
| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Long Description
Post a schedule
...
Post A Schedule
Two examples of posting a schedule to Dataloy VMS. To get an overview of all fields available have a look at the following see resources: VoyageHeader, Voyage, PortCall
| Code Block |
|---|
POST /VoyageHeader
{
"vesselCode":"100",
"company": "10",
"businessUnit":"2000",
"voyageStartYear":2015,
"voyageStartDate": "2015-01-04T00:00:00",
"voyageNo": 900,
"voyage": {
"ballastPort": 100597,
"voyageCurrency": "USD",
"daysTotal": 10,
"portCalls": [
{
"portCallSequence":1,
"reasonForCall":"L",
"currency":"USD",
"port":100597,
"speed": 8.5,
"distanceActual":200,
"daysAtSea":1,
"eventLogs": [
{
"event": "ARR",
"eventLogDate": "2015-01-05T00:00:00"
},
{
"event": "BRT",
"eventLogDate": "2015-01-05T01:00:00"
},
{
"event": "DEP",
"eventLogDate": "2015-01-06T00:00:00"
}
]
},
{
"portCallSequence":2,
"reasonForCall":"D",
"currency":"USD",
"port":100597,
"speed": 8.5,
"distanceActual":200,
"daysAtSea":1,
"eventLogs": [
{
"event": "ARR",
"eventLogDate": "2015-01-07T00:00:00"
},
{
"event": "BRT",
"eventLogDate": "2015-01-07T01:00:00"
},
{
"event": "DEP",
"eventLogDate": "2015-01-08T00:00:00"
}
]
}
]
}
} |
For Minimum message required for a schedule to appear in Booking and Operations in Dataloy VMS, the following message is a minimum:
| Code Block |
|---|
POST /VoyageHeader
{
"vesselCode":"100",
"voyage": {
"ballastPort": 100597,
"voyageCurrency": "USD",
"voyageStartDate": "2015-01-04T00:00:00",
"portCalls": [
{
"portCallSequence":1,
"reasonForCall":"L",
"currency":"USD",
"port":100597,
"eventLogs": [
{
"event": "ARR",
"eventLogDate": "2015-01-05T00:00:00"
},
{
"event": "BRT",
"eventLogDate": "2015-01-05T01:00:00"
},
{
"event": "DEP",
"eventLogDate": "2015-01-06T00:00:00"
}
]
}
]
}
} |
...
Get A Schedule
There are various ways to extract a schedule. Here are some examples, for example:
| Code Block |
|---|
GET /VoyageHeader/{key}
GET /VoyageHeader?filter=vesselCode(EQ)100&filter=voyageNo(EQ)1
GET /VoyageHeader?filter=referenceNo(EQ)1000 |
...