Skip to content

schedules resource

Base endpoint:

{server_url}/schedule

Contains a driver's schedule, which includes their pick-up and drop-off commitments.

Resource properties

Sample schedules resource

{
    "driverId": "1",
    "title": "Baseball practice",
    "passenger": "Molly",
    "pickupLocation": "123 Main St, Springfield",
    "dropoffLocation": "456 Elm St, Springfield",
    "pickupTime": "2024-06-15T08:00:00Z",
    "dropoffTime": "2024-06-15T08:30:00Z",
     "status": "Scheduled",
    "id": 1
}
Property Description Type Required Notes
driverId The ID of the driver resource to which this schedule is assigned. number Required
title The title or short description of the driving schedule. number Required Example: Vet visit, School run.
passenger Who the driver is to transport. string Required
pickupLocation Where the driver is to pick up a passenger. string Required
dropoffLocation Where the driver is to drop off a passenger. string Required
pickupTime When the driver is to pick up a passenger. string Required The ISO 8601 format of the date and time: YYYY-MM-DDTHH:MM:SS
dropoffTime When the driver is to drop off a passenger. string Required The ISO 8601 format of the date and time: YYYY-MM-DDTHH:MM:SS
status The status of the driving schedule. string Required Allowed status values are Scheduled, Canceled, Rescheduled.
id The driving schedule's unique record ID. number Required

Operations

The schedules resource supports these operations.

RETRIEVE (GET)

CREATE (POST)

UPDATE (PUT/PATCH)

DELETE