Documentation Powered by ReDoc

Runsheet Broadcast Plan Service API (1.0.0)

Perform CRUD actions for runsheet broadcast plan.

Authentication

bearerAuth

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

Return the list of plans

Return the list of plans

Authorizations:
bearerAuth
query Parameters
page
integer <int64> >= 1
Default: 1
per_page
integer <int64> >= 1
Default: 200
order
string
Default: "desc"
Enum: "asc" "desc"

The direction of the sort

range_start_created_at
string <date-time>

Range start (inclusive) of Created At

range_end_created_at
string <date-time>

Range end (inclusive) of Created At

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "plans": [
    ]
}

Create a RB Plan

Create a RB Plan

Authorizations:
bearerAuth
Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "My Runsheet Broadcast Plan"
}

Response samples

Content type
application/json
{
  • "pairs": [
    ],
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "My Runsheet Broadcast Plan",
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "version_seq": 0,
  • "version_rev": "0-vs6EOoGd"
}

Read an existing plan

Read an existing plan

path Parameters
planID
required
string

ID of the plan to be read

Responses

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "My Runsheet Broadcast Plan",
  • "pairs": [
    ],
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "version_seq": 0,
  • "version_rev": "0-vs6EOoGd"
}

Update an existing plan

Update an existing plan

path Parameters
planID
required
string

ID of the plan to be update

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "My Runsheet Broadcast Plan"
}

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "My Runsheet Broadcast Plan",
  • "pairs": [
    ],
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "version_seq": 0,
  • "version_rev": "0-vs6EOoGd"
}

Delete an existing plan

Deleted plan is not recoverable

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan to be deleted

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully deleted the plan"
}

Add Pair to an existing plan

Add Pair to an existing plan

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan to be read

Request Body schema: application/json
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "My Runsheet Broadcast Plan",
  • "pairs": [
    ],
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "version_seq": 0,
  • "version_rev": "0-vs6EOoGd"
}

Read an existing pair from an existing plan

Only designated driver is authorized.

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan which owns the pair

pairID
required
string

ID of the pair to be read

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "runsheet": {
    },
  • "driver": {
    }
}

Delete Pair from an existing plan

Delete Pair from an existing plan

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan to be read

pairID
required
string

ID of the pair to be delete

Responses

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "My Runsheet Broadcast Plan",
  • "pairs": [
    ],
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "version_seq": 0,
  • "version_rev": "0-vs6EOoGd"
}

Accept specific pair of Plan

Only designated driver is authorized.

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan which owns the pair

pairID
required
string

ID of the pair to be accept

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully recorded acceptance of runsheet with ID: xxx-xxxxx-xxx-xx"
}

Reject specific pair of Plan

Only designated driver is authorized.

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan which owns the pair

pairID
required
string

ID of the pair to be reject

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully recorded rejection of runsheet with ID: xxx-xxxxx-xxx-xx"
}

Start an existing Plan

Start Plan

Authorizations:
bearerAuth
path Parameters
planID
required
string

ID of the plan to be executed

Responses

Response samples

Content type
application/json
{
  • "server_time": "2019-08-24T14:15:22Z",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "My Runsheet Broadcast Plan",
  • "pairs": [
    ],
  • "last_executed_at_client_time_utc": "2019-08-24T14:15:22Z",
  • "last_executed_at_client_timezone": "Asia/Singapore",
  • "last_executed_at_server_time": "2019-08-24T14:15:22Z",
  • "version_seq": 0,
  • "version_rev": "0-vs6EOoGd"
}