Ridehail to Dispatch Migration Guide
This guide will help you migrate from our Ridehail API to our new Dispatch API.
Fleets
Action | Ridehail Call(s) | Example Request | Dispatch Call(s) | Example Request |
Get all fleets for account | ride-hail-operations/v1/ GetFleets |
|
dispatch-fleets/v3/ GetAllFleets |
|
Create a new Fleet | ride-hail-operations/v1/ CreateFleet |
|
dispatch-fleets/v3/ CreateFleet |
|
Update an existing fleet | ride-hail-operations/v1/ UpdateFleet |
|
dispatch-fleets/v3/ UpdateFleet |
|
Remove an existing fleet | ride-hail-operations/v1/ RemoveFleet |
|
dispatch-fleets/v3/ DeleteFleet |
|
Vehicles
Action | Ridehail Call(s) | Example Request | Dispatch Call(s) | Example Request |
Create new vehicle | ride-hail-driver/v1/ CreateVehicle |
|
dispatch-vehicles/ v3/ CreateVehicle |
|
Get all vehicles in fleet | ride-hail-operations/v1/ GetVehicles |
|
dispatch-vehicles/ v3/ GetVehiclesInFleet |
| Update an existing vehicle | ride-hail-driver/v1/ UpdateVehicle OR ride-hail-operations/v1/ UpdateVehicle |
|
dispatch-vehicles/v3/ UpdateVehicle |
|
Update whether a vehicle is accepting new tasks | ride-hail-driver/v1/ UpdateVehicleState OR ride-hail-operations/v1/ UpdateVehicleState |
|
dispatch-vehicle-state/v3/ UpdateVehicleState |
|
Update a vehicle’s position | ride-hail-driver/v1/ UpdateVehicleState |
|
dispatch-vehicle-position/v3/ UpdateVehiclePosition |
|
Remove an existing vehicle | ride-hail-driver/v1/ RemoveVehicle |
|
dispatch-vehicles/v3/ DeleteVehicle |
|
Get eyeball ETAs to rider position | ride-hail-rider/v1/ GetVehicleEtasToPosition |
|
dispatch-vehicle-eta/v3/ GetVehicleEtasToPosition |
|
Trips
Action | Ridehail Call(s) | Example Request | Dispatch Call(s) | Example Request |
Get static information about a trip | ride-hail-rider/v1/ GetTripDefinition OR ride-hail-rider/v1/ GetTripInfo OR ride-hail-driver/v1/ GetTripInfo |
|
dispatch-tasks/v3/ GetTask |
|
Get all active trips in a fleet | ride-hail-operations/v1/ GetTrips |
|
dispatch-tasks/v3/ GetTasksByTime |
|
Get a trip’s state and information about the assigned vehicle | ride-hail-rider/v1/ GetTripStateRC |
|
dispatch-tasks/v3/ GetTask (returns assigned vehicle ID) |
|
dispatch-vehicle-position/v3/ GetVehiclePosition |
| |||
dispatch-vehicle-state/v3/ GetVehicleState |
| |||
dispatch-vehicle-eta/v3/ GetVehicleStepEtas |
| |||
Request a new passenger trip | ride-hail-rider/v1/ RequestTripRC |
|
dispatch-tasks/v3/ CreateTask |
|
Complete one or more steps in a trip | ride-hail-driver/v1/ CompleteSteps |
|
dispatch-tasks/v3/ CompleteSteps |
|
Cancel an active trip | ride-hail-driver/v1/ CancelTrip OR ride-hail-rider/v1/ CancelTrip OR ride-hail-operations/v1/ CancelTrip |
|
dispatch-tasks/v3/ CancelTask |
|
Reject a trip assigned to a vehicle | ride-hail-driver/v1/ RejectTrip |
|
dispatch-tasks/v3/ RejectTask |
|
Unassign a trip from a vehicle | ride-hail-operations/v1/ UnassignTrip |
|
dispatch-tasks/v3/ UnassignTask |
|
Update trip metadata | ride-hail-operations/v1/ UpdateTrip |
|
dispatch-tasks/v3/ UpdateTask |
|