The voyage API endpoint allows querying for one voyage.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Voyage Not Found
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/voyage/:number.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"
{
   "actions": {
      "index": {
          "method": "GET",
          "url": "http://app.octopi.co/api/v1/voyages.json"
      }
   },
   "voyage" : {
      "arrival_number_of_tug_boats" : null,
      "actual_time_of_anchorage" : "2017-10-16T04:00:00Z",
      "next_port_of_call" : {
         "name" : null,
         "locode" : null
      },
      "departure_pilot" : {
         "name" : null
      },
      "assigned_berth_area" : {
         "name" : null
      },
      "actual_time_of_departure" : "2017-10-20T04:00:00Z",
      "actual_time_of_berth" : null,
      "captain" : {
         "name" : null
      },
      "estimated_time_of_anchorage" : "2017-10-16T04:00:00Z",
      "display_name" : "BLUE H 45645",
      "last_port_of_call" : {
         "name" : null,
         "locode" : null
      },
      "discharge_terminal" : {
         "name" : "BLUE TERMINAL"
      },
      "vessel" : {
         "loa" : "",
         "gross_tonnage" : 0,
         "call_sign" : null,
         "vessel_type" : "Break Bulk",
         "net_tonnage" : 0,
         "flag" : null,
         "imo" : null,
         "name" : "BLUE H"
      },
      "arrival_pilot" : {
         "name" : null
      },
      "agent" : {
         "name" : null
      },
      "actual_time_of_departure_pilot_boarded" : null,
      "tax_date" : null,
      "departure_number_of_tug_boats" : 0,
      "number_of_tug_boats" : 0,
      "ship" : {
         "vessel_type" : "Break Bulk",
         "call_sign" : null,
         "loa" : "",
         "gross_tonnage" : 0,
         "flag" : null,
         "imo" : null,
         "name" : "BLUE H",
         "net_tonnage" : 0
      },
      "closing_comments" : null,
      "actual_time_of_pilot_boarded" : null,
      "updated_at" : "2018-03-05T00:32:50Z",
      "status" : "departed",
      "estimated_time_of_departure" : null,
      "id" : 167592,
      "created_at" : "2018-03-05T00:30:33Z",
      "actual_time_of_customs_clearance" : null,
      "number" : "45645",
      "assigned_yard_area" : {
         "name" : null
      }
   }
}