Schedule API

Short Description

This resource enables POST and GET schedules in Dataloy VMS. A simple first version that will insert a schedule without making any calculations in the VMS. The schedules should not be edited in the VMS as they will then be recalculated.

Chapter Contents:

Long Description

Post a Schedule

Two examples of posting a schedule to Dataloy VMS. To get an overview of all fields available see resources: VoyageHeader, Voyage, PortCall

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"
					}  
				]
			}
		]
    }
}

Minimum message required for a schedule to appear in Booking and Operations:

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, for example:

GET /VoyageHeader/{key}
GET /VoyageHeader?filter=vesselCode(EQ)100&filter=voyageNo(EQ)1
GET /VoyageHeader?filter=referenceNo(EQ)1000

Top
Back

Dataloy API

Schedule API

Analytics

Short Description

Long Description

Post a Schedule

Get a Schedule

Related Content

Related content