Favourite Drivers

Get current operator company’s favourite drivers

GET favourite drivers

Endpoint

GET /api/v1/favourite_drivers

Parameters

Name Description
by_name Filter by driver name
page Page number
per_page Number of items per page

Request

Route

GET /api/v1/favourite_drivers?by_name=John&by_state=former

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIzNTUiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3Mzc1NTE1NTksImV4cCI6MTc0MDE0MzU1OSwianRpIjoiYTRhYTRmNjUtNmU1OS00MDRmLTg2ZjUtN2Q4MWNkNzlmMGYyIn0.Rt92zGEc7dZr8Cky8lBy-OHfX-9OjEKa7kdbVFjGWBI
Host: example.org
Cookie:

Query Parameters

by_name=John
by_state=former

Response

Simulated Response

Status

200

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
per-page: 20
total: 2
content-type: application/json; charset=utf-8
vary: Accept, Origin
etag: W/"56435353e330a8516ba2f95b8b3bef0f"
cache-control: max-age=0, private, must-revalidate
x-request-id: d1b13975-10dd-4361-90b2-c96191a9c193
x-runtime: 0.024879
content-length: 338

Body

{
  "favourite_drivers": [
    {
      "id": 19,
      "chat_id": 209,
      "driver": {
        "id": 357,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 112,
        "referral_code": "863834"
      },
      "job_name": "Legal Assistant"
    },
    {
      "id": 20,
      "chat_id": 211,
      "driver": {
        "id": 358,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 113,
        "referral_code": "855300"
      },
      "job_name": "International Consultant"
    }
  ]
}