Schedule API

Create a Voyage with a Loading and Discharging PortCall with one Cargo with a Loading and Discharging CargoPort.

POST /Voyage { "ballastPort":102546, "vessel":1609791, "cargos":[ { "cargoMeasurement":"MT", "cargoType":"SPOT", "cargoPorts":[ { "cargoPortSequence":1, "port":105219, "reasonForCall":"L" }, { "cargoPortSequence":1, "port":101770, "reasonForCall":"D" } ] } ], "portCallsFromVoyage":[ { "port":105219, "portCallSequence":1, "reasonForCall":"L", "currency":"EUR" }, { "port":101770, "portCallSequence":2, "reasonForCall":"D", "currency":"EUR" } ] }

The created voyage will get the status Estimated (code EST).

Creating a new Cargo with a Loading and Discharging CargoPort and PortCall. The PortCall objects have EventLogDates that specify Arrival, Berthing, Un-berthing, and Departure dates.

POST /Cargo
 
{
    "cargoMeasurement": "MT",
    "cargoPorts": [
        {
            "cargoPortSequence": 1,
            "cargoQuantity": 1234,
            "laytimeTermsMeasurement": "H",
            "port": {
                "key": 102381
            },
            "portCall": {
                "portCallSequence": 3,
                "reasonForCall": "L",
                "port": 102381,
                "voyage": 6136896
            },
            "reasonForCall": "L"
        },
        {
            "cargoPortSequence": 1,
            "cargoQuantity": 1234,
            "freightRate": 1210,
            "laytimeTermsMeasurement": "H",
            "port": {
                "key": 101486
            },
            "portCall": {
                "portCallSequence": 4,
                "reasonForCall": "D",
                "port": 101486,
                "voyage": 6136896
            },
            "reasonForCall": "D"
        }
    ],
    "charterer": {
        "key": 1004307
    },
    "commodity": {
        "key": 1675975
    },
    "freightCurrency": "USD",
    "voyage": {
        "key": 6136896
    }
}

Adding to a Cargo a new Loading or Discharging CargoPort and PortCall

PUT /Cargo/{KEY}
 
{
    "cargoPorts": [
        {
            "key": 18739785
        },
        {
            "key": 18739786
        },
        {
            "port": 103991,
            "reasonForCall": "D",
            "cargoPortSequence": 2,
            "portCall": {
                "portCallSequence": 6,
                "reasonForCall": "D",
                "port": 103991,
                "voyage": 18739534,
                "ownedByVoyage": 18739534
            }
        }
    ]
}

Fixing the date on an EventLog object. Note, only EventLogs with EventLog.EventLogDate from the past can be fixed, otherwise, the returned value of isDateFixed will be false.

PUT /EventLog/{KEY}

{
    "isDateFixed":true
}

Nominate an estimate voyage

To nominate a voyage of a given vessel first you need to get the last sequence for the vessel in the fleet plan:

GET https://dev.dataloy.com/ws/rest/Voyage?filter=vessel(EQ)1609791&fleetPlanVoyages.fleetPlan.fleetPlanCode(EQ)MASTER&filter=voyageHeader.voyageStatus.statusTypeCode(NE)EST&sort=fleetPlanVoyages.sequence(DS)

sending the HTTP Header property fileds withi this value:

{"fleetPlanVoyages":{"sequence":"*"}}

Then you can nominate the voyage making a PUT sending this payload:

{
   "key":76409955,
   "voyageHeader":{
      "key":76409960,
      "voyageStatus":"NOM",
      "isVoyageStartFixed":false,
      "isEstimate":false,
      "isUnallocated":false
   },
   "fleetPlanVoyages":[
      {
         "fleetPlan":"MASTER",
         "voyage":76409955,
         "sequence":11,
         "vessel":1609791
      }
   ]
}

incrementing the sequence by 1.