For drivers not using the Yojee Driver App, tasks can be completed using the Yojee API
Use this endpoint to complete a task by a Dispatcher.
- POST api/v3/dispatcher/task_groups/{task_group_id}/task/{id}/complete
- API reference link: https://api-docs.yojee.com/#dispatcher-taskcontroller-complete
Request Parameters
|
Parameter |
Required? |
Type |
Description |
|
access_token |
Yes |
String |
Access token generated |
|
company_slug |
Yes |
String |
Dispatcher company slug |
|
task_group_id |
Yes |
Integer |
Task Group Id |
|
id |
Yes |
Integer |
Task id |
Request Sample cURL/Payload
curl -X POST "https://umbrella-dev.yojee.com/api/v3/dispatcher/task_groups/14074/task/24415/complete" -H "accept: application/json" -H "ACCESS_TOKEN: pCVPeEEUuKnM7geUOcSLY2imA5l6YUdjymkApBDAAGY=" -H "COMPANY_SLUG: yojee"
Sample Response Body
Server Code Status: 200 => Task completed successfully by dispatcher
example value(s)
{
"data": {
"completion_time": "2019-06-19T08:08:30.092122Z",
"id": 24415,
"start_time": null,
"state": "completed",
"task_group_id": 14074
}
}