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.eyJzdWIiOiIzNzUiLCJzY3AiOiJ1c2VyIiwiYXVkIjpudWxsLCJpYXQiOjE3NDI0NjQ5MTQsImV4cCI6MTc0NTA1NjkxNCwianRpIjoiNzRlYzA5NWYtNjk3NS00YjcxLTlkOTktMDRiODYyNDNhYzkxIn0.ebMJ081Ct9XGsvykLXy0ON1bnd8KkfFj4LDl81VnH04
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/"29207dea269bc53a0eda00511241af2b"
cache-control: max-age=0, private, must-revalidate
x-request-id: 25afdea7-bfbe-47c1-b574-c339586f827f
x-runtime: 0.022918
content-length: 338

Body

{
  "favourite_drivers": [
    {
      "id": 19,
      "chat_id": 223,
      "driver": {
        "id": 377,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 119,
        "referral_code": "511168"
      },
      "job_name": "Manufacturing Producer"
    },
    {
      "id": 20,
      "chat_id": 225,
      "driver": {
        "id": 378,
        "first_name": "John",
        "last_name": "Doe",
        "profile_id": 120,
        "referral_code": "400670"
      },
      "job_name": "Education Planner"
    }
  ]
}