Search a (unique) truck by number and carrierId

GET /api/truck/byNumberAndCarrier/{number}{carrierId}

A status of 200 just means there were no errors during the search. If the truck is found, the truck object will be returned in the response body. If no truck is found then the response body will be empty.

Headers

X-Gatego-oid

Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

number string

Please note this is a matrix variable as number and carrierId both identify a truck at the same level, so please use the semicolon to specify the variables in the path
carrierId integer(int64)

Please note this is a matrix variable as number and carrierId both identify a truck at the same level, so please use the semicolon to specify the variables in the path

Responses

200 */*

OK
Hide response attributes Show response attributes object
- carrier object
  
  Hide carrier attributes Show carrier attributes object
  
  address string
  
  address_additional_info string
  
  authorized boolean
  
  created_at string(date-time)
  
  created_by string
  
  email string
  
  fleet_id string
  
  id integer(int64)
  
  last_modified_at string(date-time)
  
  last_modified_by string
  
  name string
  
  rfc string
  
  scac string
  
  usdot string
- fuel_type string
  
  Values are CNG, DIESEL, ELECTRIC, or HYDROGEN.
- id integer(int64)
- number string
- type string
  
  Values are BOX, PICKUP, or SEMI.
401

Unauthorized
403

Forbidden
404

Not Found

GET /api/truck/byNumberAndCarrier/{number}{carrierId}

curl \
 -X GET http://127.0.0.1:8080/api/truck/byNumberAndCarrier/{number}{carrierId}

Response examples (200)

{
  "carrier": {
    "address": "string",
    "address_additional_info": "string",
    "authorized": true,
    "created_at": "2024-05-04T09:42:00+00:00",
    "created_by": "string",
    "email": "string",
    "fleet_id": "string",
    "id": 42,
    "last_modified_at": "2024-05-04T09:42:00+00:00",
    "last_modified_by": "string",
    "name": "string",
    "rfc": "string",
    "scac": "string",
    "usdot": "string"
  },
  "fuel_type": "CNG",
  "id": 42,
  "number": "string",
  "type": "BOX"
}