GET /api/v1/vessels/:name
Returns information about a vessel

Returns information about the vessel. If the vessel recently completed a voyage, then it also returns information about that last voyage. Vessel can be identified by name or IMO number.

Supported Formats

json

Errors

Code	Description
404	Not found.
500	Server crashed.

Examples

curl "https://app.octopi.co/api/v1/vessels/CFS%20Paceno.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"
curl "https://app.octopi.co/api/v1/vessels/9403451.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOURTOKEN"  

  {
   "vessel" : {
      "id" : 1234,
      "gross_tonnage" : 9957,
      "call_sign" : "6YSO4",
      "imo_number" : "9403451",
      "length_overall" : "148m × 23.25m",
      "actions" : {
         "show" : {
            "method" : "GET",
            "url" : "https://app.octopi.co/api/v1/vessels/CFS%20Paceno.json"
         }
      },
      "name" : "CFS Paceno"
   }
}

Params

Param name	Description
name required	Vessel name or IMO number. Validations: Must be a String