Skip to main content

DriverModel

Driver profile.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"address": "String",
"can_assign_to": "array[truck_id], optional",
"can_convert_to_group": "Boolean",
"can_create_requests": "Boolean",
"can_dispatch_to": "array[truck_id], optional",
"can_edit_requests": "Boolean",
"can_reposition_asset": "Boolean",
"city": "String",
"disable_shift_tracking": "Boolean",
"email": "String",
"id": "Integer",
"is_deactivated": "Boolean",
"license_number": "String",
"location_id": "Integer",
"name": "String",
"phone_number": "String",
"state": "String",
"third_party_hauler_id": "String",
"username": "String",
"zip": "String"
}

Fields​

address String, Required

Street address.

  • At least 1 and no more than 200 characters.

can_assign_to Array[truck_id], Optional

truck_id Integer

Truck identifier.

can_convert_to_group Boolean, Required

Can driver convert to group.

  • One of 0, 1, True, False (case insensitive).

can_create_requests Boolean, Required

Can driver create requests.

  • One of 0, 1, True, False (case insensitive).

can_dispatch_to Array[truck_id], Optional

truck_id Integer

Truck identifier.

can_edit_requests Boolean, Required

Can driver edit requests.

  • One of 0, 1, True, False (case insensitive).

can_reposition_asset Boolean, Required

Can driver reposition asset.

  • One of 0, 1, True, False (case insensitive).

city String, Required

Driver city.

  • At least 1 and no more than 50 characters.

disable_shift_tracking Boolean, Required

Disable shift tracking.

  • One of 0, 1, True, False (case insensitive).

email String, Required

Email address.

  • Valid email address.

id Integer, Required

Driver user identifier.

is_deactivated Boolean, Required

Driver inactive if TRUE.

  • One of 0, 1, True, False (case insensitive).

license_number String, Required

Driver's license number.

  • At least 1 and no more than 100 characters.

location_id Integer, Required

Location identifier.

name String, Required

Name (free text).

  • At least 1 and no more than 64 characters.

phone_number String, Required

Phone number.

  • At least 7 characters, not more than 15.
  • At least 0 and no more than 50 characters.

state String, Required

Driver state.

  • At least 1 and no more than 50 characters.

third_party_hauler_id String, Required

Third party hauler identifier.

  • Valid UUID.

username String, Required

Username.

  • No longer than 64 characters.
  • At least 1 characters long.

zip String, Required

Postal code (may include letters and symbols).

  • At least 1 and no more than 20 characters.