vessels

Create a new vessel route

Changed on
post/vessels/routes

Request

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

Request body

vesselIdinteger required
departurePortstring required
arrivalPortstring required
departureAtstring date-time
estimatedArrivalAtstring date-time
waypointsobject[]

Response

Route created

idinteger required
vesselIdinteger required
namestring nullable
departurePortstring required
arrivalPortstring required
departureAtstring date-time nullable
estimatedArrivalAtstring date-time nullable
status'planned' | 'active' | 'completed' | 'cancelled' required
waypointsobject[]

Changes