gatego API documentation

Update

PATCH /api/driver/{id}

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)

Path parameters

id integer(int64) Required

id

application/json

Body

carrier_id integer(int64)
license string
license_expiration string(date-time)
license_picture_id integer(int64)
name string
notification_email string
notification_phone string
notification_preference_channel string

Values are EMAIL, SMS, or WHATSAPP.
photo_id integer(int64)
truck_carrier_id integer(int64)
truck_fuel_type string

Values are CNG, DIESEL, ELECTRIC, or HYDROGEN.
truck_id integer(int64)
truck_number string
truck_type string

Values are BOX, PICKUP, or SEMI.

Responses

• 200

OK
Hide response attributes Show response attributes object
- account object
  
  Hide account attributes Show account attributes
  
  active boolean
  
  can_view_carrier_ids array[integer(int64)]
  
  can_view_other_carriers boolean
  
  carrier_id integer(int64)
  
  deleted_at string(date-time)
  
  driver object
  
  Hide driver attributes Show driver attributes
  
  license string
  
  license_expiration string(date-time)
  
  license_picture_id string
  
  photo_id string
  
  truck_number string
  
  driver_license string
  
  driver_license_expiration string(date-time)
  
  driver_license_picture_id integer(int64)
  
  driver_photo_id integer(int64)
  
  driver_truck_number string
  
  email string
  
  email_confirmed boolean
  
  Whether user has confirmed his email address
  
  hmac string
  
  HMAC-SHA256 of the user id
  
  hmac_android string
  
  hmac_ios string
  
  id integer(int64)
  
  language_code string
  
  last_login string(date-time)
  
  last_login_app_version string
  
  last_login_referer string
  
  managed_organization_group object
  
  Hide managed_organization_group attributes Show managed_organization_group attributes
  
  id integer(int64)
  
  managed_organizations array[object]
  
  Hide managed_organizations attributes Show managed_organizations attributes
  
  id integer(int64)
  
  name string
  
  name string
  
  name string
  
  organization object
  
  Hide organization attributes Show organization attributes
  
  id integer(int64)
  
  name string
  
  phone_number string
  
  previous_last_login string(date-time)
  
  role string
  
  Values are ADMIN, CARRIER_ADMIN, DRIVER, GUARD, ORG_ADMIN, ORG_GROUP_ADMIN, SIGNUP_SERVICE, or SUPER_CARRIER_ADMIN.
  
  username string
  
  yard_id integer(int64)
- active boolean
- 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)
- created_at string(date-time)
- id integer(int64)
- last_modified_at string(date-time)
- license string
- license_expiration string(date-time)
- license_picture object
  
  Hide license_picture attributes Show license_picture attributes
  
  id integer(int64)
  
  name string
  
  type string
  
  Values are DRIVER_LICENSE_PHOTO, DRIVER_PHOTO, EXTRA_FILE, GUEST_VEHICLE_PHOTO, TIRE_PHOTO, TRAILER_INSIDE_PHOTO, TRAILER_ISSUE_PHOTO, TRAILER_LEFT_PHOTO, TRAILER_RIGHT_PHOTO, TRAILER_SEAL_PHOTO, TRUCK_ISSUE_PHOTO, or TRUCK_PHOTO.
  
  url string
- license_picture_id integer(int64)
- name string
- organization_id integer(int64)
- photo_id integer(int64)
- truck_carrier object
  
  Hide truck_carrier attributes Show truck_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
- truck_id integer(int64)
- truck_number string
• 204

No Content
• 401

Unauthorized
• 403

Forbidden

PATCH /api/driver/{id}

curl \
 -X PATCH https://api-dev.gatego.io:443/api/driver/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"carrier_id":42,"license":"string","license_expiration":"2023-05-04T09:42:00+00:00","license_picture_id":42,"name":"string","notification_email":"string","notification_phone":"string","notification_preference_channel":"EMAIL","photo_id":42,"truck_carrier_id":42,"truck_fuel_type":"CNG","truck_id":42,"truck_number":"string","truck_type":"BOX"}'

Request example

# Headers

# Payload
{
  "carrier_id": 42,
  "license": "string",
  "license_expiration": "2023-05-04T09:42:00+00:00",
  "license_picture_id": 42,
  "name": "string",
  "notification_email": "string",
  "notification_phone": "string",
  "notification_preference_channel": "EMAIL",
  "photo_id": 42,
  "truck_carrier_id": 42,
  "truck_fuel_type": "CNG",
  "truck_id": 42,
  "truck_number": "string",
  "truck_type": "BOX"
}

Response examples (200)

{
  "account": {
    "active": true,
    "can_view_carrier_ids": [
      42
    ],
    "can_view_other_carriers": true,
    "carrier_id": 42,
    "deleted_at": "2023-05-04T09:42:00+00:00",
    "driver": {
      "license": "string",
      "license_expiration": "2023-05-04T09:42:00+00:00",
      "license_picture_id": "string",
      "photo_id": "string",
      "truck_number": "string"
    },
    "driver_license": "string",
    "driver_license_expiration": "2023-05-04T09:42:00+00:00",
    "driver_license_picture_id": 42,
    "driver_photo_id": 42,
    "driver_truck_number": "string",
    "email": "string",
    "email_confirmed": false,
    "hmac": "string",
    "hmac_android": "string",
    "hmac_ios": "string",
    "id": 42,
    "language_code": "string",
    "last_login": "2023-05-04T09:42:00+00:00",
    "last_login_app_version": "string",
    "last_login_referer": "string",
    "managed_organization_group": {
      "id": 42,
      "managed_organizations": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "name": "string"
    },
    "name": "string",
    "organization": {
      "id": 42,
      "name": "string"
    },
    "phone_number": "string",
    "previous_last_login": "2023-05-04T09:42:00+00:00",
    "role": "ADMIN",
    "username": "string",
    "yard_id": 42
  },
  "active": true,
  "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
      }
    ]
  },
  "created_at": "2023-05-04T09:42:00+00:00",
  "id": 42,
  "last_modified_at": "2023-05-04T09:42:00+00:00",
  "license": "string",
  "license_expiration": "2023-05-04T09:42:00+00:00",
  "license_picture": {
    "id": 42,
    "name": "string",
    "type": "DRIVER_LICENSE_PHOTO",
    "url": "string"
  },
  "license_picture_id": 42,
  "name": "string",
  "organization_id": 42,
  "photo_id": 42,
  "truck_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"
  },
  "truck_id": 42,
  "truck_number": "string"
}