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
      },
      "flex_fileds": [
        {
          "label": "Name",
          "value": "Octopi"
        }
      ]
   }
}

curl "https://app.octopi.co/api/v1/voyages/:number.json" -d '{"voyage": { "Captain": "Cook", "at_of_departure": "2021-12-05T18:41:17.422Z" }}' -X PATCH -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"

Params

Param name	Description
at_of_departure_pilot_boarded optional	Validations: Must be a String
at_of_anchorage optional	Validations: Must be a String
at_of_pilot_boarded optional	Validations: Must be a String
at_of_berth optional	Validations: Must be a String
at_of_customs_clearance optional	Validations: Must be a String
at_berth_departure optional	Validations: Must be a String
at_of_departure optional	Validations: Must be a String
agent_id optional	Validations: Must be a Integer
arrival_pilot_id optional	Validations: Must be a Integer
assigned_berth_area_id optional	Validations: Must be a Integer
assigned_yard_area_id optional	Validations: Must be a Integer
berth_end_position optional	Validations: Must be a Float
berth_start_position optional	Validations: Must be a Float
block_receiving_export_past_cut_off optional	Validations: Must be a String
captain optional	Validations: Must be a String
departed_last_port_on optional	Validations: Must be a String
departure_pilot_id optional	Validations: Must be a Integer
discharge_destination_id optional	Validations: Must be a Integer
et_of_anchorage optional	Validations: Must be a String
et_of_berth optional	Validations: Must be a String
et_of_departure optional	Validations: Must be a String
cancelled optional	Validations: Must be a String
last_port_of_call_id optional	Validations: Must be a Integer
next_port_of_call_id optional	Validations: Must be a Integer
receiving_cut_off_time optional	Validations: Must be a String
ship_id optional	Validations: Must be a Integer
stevedoring_company_id optional	Validations: Must be a Integer
tax_date optional	Validations: Must be a String
time_labour_ashore optional	Validations: Must be a String
time_labour_onboard optional	Validations: Must be a String