GET /api/v1/vessel_tallies.json
Get a list of vessel tallies.

This API endpoint allows you to view vessel tallies.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not found.
500 Internal server error.

Examples

curl --location --request GET 'https://app.octopi.co/api/v1/vessel_tallies.json?vessel_name=tropic&voyage_number=0577'     --header 'Authorization: Token token=ADD TOKEN HERE'

{
  "vessel_tallies": [
    {
      "id": 22867,
      "vessel_name": "TROPIC JEWEL",
      "voyage_number": "2022050577",
      "type": "Discharge",
      "prepared_on": "2022-05-15T12:13:58Z",
      "completed_at": null,
      "closed_at": null
    }
  ]
}

Params

Param name Description
type
optional

Filter tallies by the operation type.

Validations:

  • Must be one of: discharge, loading.
vessel_name
optional

Filter tallies by the vessel name.

Validations:

  • Must be a String
voyage_number
optional

Filter tallies by the voyage number.

Validations:

  • Must be a String
page
optional

Specify which page of results to fetch. This value defaults to 1.

Validations:

  • Must be a number.
per
optional

The number of items to be displayed. This value defaults to 10 and accepts a maximum of 100.

Validations:

  • Must be a number.