Get Sandbox Run
GEThttps://sandbox-api.uber.com/v1/guests/sandbox/run/{run_id}¶ Use case
Use this endpoint to retrieve a mock run’s set of driver_ids.
Wait 1 minute after calling /v1/guests/sandbox/run before calling this.
¶ Authorization
OAuth 2.0 Bearer token with the guests.trips scope.
¶ Request
¶ Example request
curl -X GET \
-H "authorization: Bearer <access_token>" \
'https://sandbox-api.uber.com/v1/guests/sandbox/run/<run_id>'
¶ Request URL parameters
| URL parameter | Type | Description |
|---|---|---|
run_id |
string |
A unique identifier of a sandbox create run request (required). |
¶ Response
¶ Example response
{
"run_id": "<run_id>",
"driver_ids": [
"<driver_id>",
"<driver_id>"
]
}
¶ Response body parameters
| Field | Type | Description |
|---|---|---|
run_id |
string |
A unique identifier of a sandbox run. |
driver_ids |
array |
List of driver IDs. |
driver_id |
string |
A driver ID is used to change the driver’s state via /v1/guests/sandbox/driver-state. |
¶ Errors
This endpoint can return an error if the run_id is not found, which usually happens if you wait less than a minute after calling /v1/guests/sandbox/run, or if there was an error when creating the run.
{
"code": "entity_not_found",
"message": "RunID is not valid"
}