GET /api/v1/truck_visits/:id
Get details of a truck visit.

Returns information about the truck visit.

Supported Formats

json

Errors

Code Description
404 Not found.
422 Unprocessable Entity.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/truck_visits/123.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"'

{
  "id": 123,
  "truck": {
    "id": 2787,
    "license_plate": "ABCX59",
    "number": "270",
    "trucking_company_id": 100,
    "active": true,
    "allowed_until": null
  },
  "truck_driver": {
    "id": 23801,
    "fullname": "John Doe",
    "license_number": "611574",
    "twic": "",
    "number": "633353",
    "active": true,
    "date_of_birth": null,
    "telephone_number": null,
    "email": null,
    "remarks": null,
    "trucking_company": "TruckingCo1",
    "allowed_until": null,
    "created_at": "2017-09-15T15:47:12Z",
    "updated_at": "2023-09-15T15:47:12Z"
  },
  "gated_in_at": null,
  "gated_out_at": null,
  "trucking_company": {
    "id": 118,
    "name": "MARTAINER, INC.",
    "code": null
  },
  "gate": {
    "id": 12,
    "name": "Some Gate"
  },
  "gate_in_user": {
    "id": 543,
    "email": "jim.shim@terminal.com",
    "firstname": "Jim",
    "lastname": "Shim",
    "name": "Jim Shim"
  },
  "interchanges": [],
  "duration": "0"
}

Params

Param name Description
id
required

Retrieve information regarding a specific truck visit with the truck visit’s ID in Octopi.

Validations:

  • Must be a Integer