gatego API documentation

GetByCarrierIdAndNumber

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

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 trailer 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 trailer 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
  
  authorized boolean
  
  created_at string(date-time)
  
  created_by 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
  
  yards array[object]
  
  Hide yards attributes Show yards attributes
  
  authorized boolean
  
  carrier_capacity integer(int64)
  
  yard_id integer(int64)
- id integer(int64)
- number string
- tags array[object]
  
  Hide tags attributes Show tags attributes
  
  associated_at string(date-time)
  
  color string
  
  created_at string(date-time)
  
  id integer(int64)
  
  last_modified_at string(date-time)
  
  name string
- type string
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

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

curl \
 -X GET https://api-dev.gatego.io:443/api/trailer/byNumberAndCarrier/{number}{carrierId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "carrier": {
    "authorized": true,
    "created_at": "2023-05-04T09:42:00+00:00",
    "created_by": "string",
    "fleet_id": "string",
    "id": 42,
    "last_modified_at": "2023-05-04T09:42:00+00:00",
    "last_modified_by": "string",
    "name": "string",
    "rfc": "string",
    "scac": "string",
    "usdot": "string",
    "yards": [
      {
        "authorized": true,
        "carrier_capacity": 42,
        "yard_id": 42
      }
    ]
  },
  "id": 42,
  "number": "string",
  "tags": [
    {
      "associated_at": "2023-05-04T09:42:00+00:00",
      "color": "string",
      "created_at": "2023-05-04T09:42:00+00:00",
      "id": 42,
      "last_modified_at": "2023-05-04T09:42:00+00:00",
      "name": "string"
    }
  ],
  "type": "string"
}