Get Driver

GET /locations/{location_id}/drivers/{driver_id}

Get driver at a given location.

Roles

Users with the following roles may access this endoint:

Admin
ClientCustomer
CrmUser
Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

Sample Request

GET /locations/{location_id}/drivers/{driver_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Allow: GET
Content-Length: 491
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:39:39 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: fbe8707b-ed75-420b-b83e-b1dae3e2a1c8

{
"address": null,
"can_assign_to": [
  1,
  2,
  6,
  8,
  9,
  16,
  17,
  18
],
"can_convert_to_group": true,
"can_create_requests": true,
"can_dispatch_to": [
  1,
  2,
  5,
  6,
  16,
  17,
  18,
  19,
  20
],
"can_edit_requests": true,
"can_reposition_asset": true,
"city": "",
"disable_shift_tracking": false,
"email": "",
"id": 100002,
"is_deactivated": false,
"license_number": "",
"location_id": 1,
"name": "Jordan Duty",
"phone_number": null,
"state": "",
"third_party_hauler_id": null,
"username": "jordan",
"zip": ""
}

Path Parameters

driver_id String, Required

Driver identifier.

---

location_id Integer, Required

Location identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

• Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
• No longer than 256 characters.
• At least 1 characters long.

---

x-api-version String, Optional

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-request-id String

Request identifier.

• Valid UUID.

Response Body

Refer to DriverModel for more details.

address String

Street address.

• At least 1 and no more than 200 characters.

---

can_assign_to Array[truck_id], Conditional

truck_id Integer

Truck identifier.

---

can_convert_to_group Boolean

Can driver convert to group.

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

---

can_create_requests Boolean

Can driver create requests.

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

---

can_dispatch_to Array[truck_id], Conditional

truck_id Integer

Truck identifier.

---

can_edit_requests Boolean

Can driver edit requests.

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

---

can_reposition_asset Boolean

Can driver reposition asset.

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

---

city String

Driver city.

• At least 1 and no more than 50 characters.

---

disable_shift_tracking Boolean

Disable shift tracking.

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

---

email String

Email address.

• Valid email address.

---

id Integer

Driver user identifier.

---

is_deactivated Boolean

Driver inactive if TRUE.

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

---

license_number String

Driver's license number.

• At least 1 and no more than 100 characters.

---

location_id Integer

Location identifier.

---

name String

Name (free text).

• At least 1 and no more than 64 characters.

---

phone_number String

Phone number.

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

---

state String

Driver state.

• At least 1 and no more than 50 characters.

---

third_party_hauler_id String

Third party hauler identifier.

• Valid UUID.

---

username String

Username.

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

---

zip String

Postal code (may include letters and symbols).

• At least 1 and no more than 20 characters.

Code Samples

cURL

curl --request GET --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
127.0.0.1:8003/locations/{location_id}/drivers/{driver_id}

Python

import requests, json

response = requests.get(
  'http://localhost:8003/locations/{location_id}/drivers/{driver_id}',
  headers={
    'Authorization': 'Bearer {your-auth-token}',
    'Content-Type': 'application/json',
    'x-tenant-id': '{your-tenant-id}'
  },
  parameters={
  }
)
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/locations/{location_id}/drivers/{driver_id}";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        string json = client.DownloadString(url);
        Console.WriteLine(json);
    }
}
}