Documentation Powered by ReDoc

Runsheet Accept Limit Service API (1.0.0)

This service is used to control the limit on the number of runsheet a driver can accept

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Create limit record for a driver

Create limit record for a driver

Authorizations:
bearerAuth
Request Body schema: application/json
runsheet_id
string <uuid>
task_ids
Array of strings <uuid>

Responses

Request samples

Content type
application/json
{
  • "runsheet_id": "11efe5a3-2e79-4946-8030-f9f750a22a76",
  • "task_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Successfully create limit record"
}

Get a limit record by runsheet id for a driver

Get a limit record by runsheet id for a driver

Authorizations:
bearerAuth
query Parameters
runsheet_id
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "limit": {
    }
}

Get driver availability to decide whether he/she c

Get driver availability to decide whether he/she can accept broadcast

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "is_available": true
}

This API will remove the task id from limit record

This API will remove the task id from limit record after the task is finished (completed, failed, cancelled)

Authorizations:
bearerAuth
query Parameters
task_id
string <uuid>
runsheet_id
string <uuid>
Request Body schema: application/json
version_rev
required
string

version_rev of the limit record

Responses

Request samples

Content type
application/json
{
  • "version_rev": "0-abcdefgh"
}

Response samples

Content type
application/json
{
  • "message": "Successfully remove task id from accept limit"
}

Get driver limits list. Only SysAdmin can access

Get driver limits list. Only SysAdmin can access

Authorizations:
bearerAuth
query Parameters
driver_id
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "limits": [
    ]
}