getShiftDetails API Endpoint

The getShiftDetails API is called to retrieve information, when the Fleet Manager wants to obtain all the details pertaining to a shift.

API Details

GET https://api.zendrive.com/fleet/v1/shift/{shift_Id}

The getShiftDetails API endpoint returns shift details given a shift_id.

Headers

Name	Type	Description
API KEY <API_KEY>*	Application/JSON	Authorization header

200: OK

{
      "shift_name":"morning_shift",
      "is_default": false,
      "shift_intervals":[
        {
          "start_time":{
            "day_of_week":"Sunday",
            "time":"11:00 PM"
          },
          "end_time":{
            "day_of_week":"Monday",
            "time":"02:00 AM"
          }
        },
        {
          "start_time":{
            "day_of_week":"Monday",
            "time":"11:00 AM"
          },
          "end_time":{
            "day_of_week":"Monday",
            "time":"02:00 PM"
          }
        }
      ],
      "created_at": "2023-07-19",
      "timezone":"America/Los_Angeles",
      "assigned_driver_count": 245
    }

204: No Content Shift_id not found

400: Bad Request Bad request with human-readable message.

401: Unauthorized Unauthorized request.

403: Forbidden Business hour feature not enabled.

404: Not Found URL not found.

500: Internal Server Error

Response (Success)

{
      "shift_name":"morning_shift",
      "is_default": false,
      "shift_intervals":[
        {
          "start_time":{
            "day_of_week":"Sunday",
            "time":"11:00 PM"
          },
          "end_time":{
            "day_of_week":"Monday",
            "time":"02:00 AM"
          }
        },
        {
          "start_time":{
            "day_of_week":"Monday",
            "time":"11:00 AM"
          },
          "end_time":{
            "day_of_week":"Monday",
            "time":"02:00 PM"
          }
        }
      ],
      "created_at": "2023-07-19",
      "timezone":"America/Los_Angeles",
      "assigned_driver_count": 245
    }

Response Fields

Response Parameter	Description
shift_name	Shift name as set by the fleet manager.
shift_id	Shift ID assigned by Zendrive.
is_default	Denotes whether the shift is a default shift or not.
shift_intervals	List of shift interval objects. Each element of the list represents a single shift interval with start and end time.
timezone	The shift timezone as set by the fleet manager.
assigned_driver_count	Number of drivers assigned to a given shift.