Documentation Powered by ReDoc

Runsheet Broadcast Limit Service API (0.0.0)

Keeps track of drivers which are not allowed to receive runsheet broadcasts

Create a new record to indicate a driver will receive a runsheet broadcast and become busy, and should not receive another broadcast thereafter

Request Body schema: application/json
driver_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "driver_id": "driver_id_uuid_xxxxx"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
  • "server_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z"
}

Get specific limit record with expire status Only for driver

Responses

Response samples

Content type
application/json
{
  • "driver_id": "d13674cc-89e2-4383-beab-46a9e6e4a9b2",
  • "server_time": "2019-08-24T14:15:22Z",
  • "expired": true
}

Frees up a driver, thereby allowing new runsheet broadcasts to the driver. For Driver only

path Parameters
driver_id
required
string <uuid>

ID of the driver that is freed up

Responses

Response samples

Content type
application/json
{
  • "driver_id": "driver_id_uuid_xxxxx",
  • "server_time": "2020-12-17T18:35:52.557035+08:00"
}

Update the expire time of limit record to infinite

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully update broadcast limit"
}

Get all limit records. Only for SysAdmin

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Frees up a driver, thereby allowing new runsheet broadcasts to the driver. For SysAdmin Only

path Parameters
driver_id
required
string <uuid>

ID of the driver that is freed up

Responses

Response samples

Content type
application/json
{
  • "driver_id": "driver_id_uuid_xxxxx",
  • "server_time": "2020-12-17T18:35:52.557035+08:00"
}