vessels

Run a route simulation

Changed on
post/vessels/simulations

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/vessels/simulations
  • Auth: one of:
    • API key in cookie session
    • HTTP bearer

Request body

vesselIdinteger required
originstring required
destinationstring required
departureAtstring date-time
speedKnotsnumber

Response

Simulation created

idinteger required
vesselIdinteger required
originstring required
destinationstring required
departureAtstring date-time nullable
estimatedArrivalAtstring date-time nullable
distanceNmnumber nullable
fuelEstimateMTnumber nullable
status'pending' | 'running' | 'completed' | 'failed' required
resultobject nullable
createdAtstring date-time required

Changes