Runsheet Broadcast Record Service API (1.0.0)

A record of statuses and results of runsheet broadcasts

Authentication

bearerAuth

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

Retrieve broadcast record of the specified broadca

Retrieve broadcast record of the specified broadcast pair

Authorizations:

bearerAuth

path Parameters

plan_id required	string <uuid> ID of the plan of the pair
pair_id required	string <uuid> ID of the pair to retrieve broadcast records of

Responses

Response samples

200

Content type

application/json

{"pair_record": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"pair": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"runsheet": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My Runsheet",
"tasks": [{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"total_item_weight": 0,
"total_weight_unit": "string",
"total_item_volume": 0,
"total_volume_unit": "string",
"total_item_count": 0,
"client_time_utc": "2019-08-24T14:15:22Z",
"client_timezone": "Asia/Singapore",
"from_address": {"street_address": "201 Henderson Road",
"city": "Singapore",
"state": "string",
"country": "Singapore",
"zip_code": 159545,
"building_name": "Apex @ Henderson"
},
"from_time_window": {"start_timezone": "Asia/Singapore",
"start_time_utc": "2019-08-24T14:15:22Z",
"end_timezone": "Asia/Singapore",
"end_time_utc": "2019-08-24T14:15:22Z"
},
"to_address": {"street_address": "201 Henderson Road",
"city": "Singapore",
"state": "string",
"country": "Singapore",
"zip_code": 159545,
"building_name": "Apex @ Henderson"
},
"to_time_window": {"start_timezone": "Asia/Singapore",
"start_time_utc": "2019-08-24T14:15:22Z",
"end_timezone": "Asia/Singapore",
"end_time_utc": "2019-08-24T14:15:22Z"
},
"version_seq": 0
}
]
},
"driver": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe"
}
},
"plan": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Runsheet Broadcast Plan"
},
"statuses": [{"current_state": "rejected",
"action": "system_rejected",
"reason": "string",
"expired_time": "2019-08-24T14:15:22Z",
"happened_at_utc": "2019-08-24T14:15:22Z",
"saved_at_utc": "2019-08-24T14:15:22Z"
}
]
}
}

Retrieve the list of broadcast records of the spec

Retrieve the list of broadcast records of the specified broadcast plan.

Authorizations:

bearerAuth

path Parameters

plan_id

required

string <uuid>

ID of the plan of the pair

Responses

Response samples

200

Content type

application/json

{"pair_records": [{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"pair": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"runsheet": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My Runsheet",
"tasks": [{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"total_item_weight": 0,
"total_weight_unit": "string",
"total_item_volume": 0,
"total_volume_unit": "string",
"total_item_count": 0,
"client_time_utc": "2019-08-24T14:15:22Z",
"client_timezone": "Asia/Singapore",
"from_address": {"street_address": "201 Henderson Road",
"city": "Singapore",
"state": "string",
"country": "Singapore",
"zip_code": 159545,
"building_name": "Apex @ Henderson"
},
"from_time_window": {"start_timezone": "Asia/Singapore",
"start_time_utc": "2019-08-24T14:15:22Z",
"end_timezone": "Asia/Singapore",
"end_time_utc": "2019-08-24T14:15:22Z"
},
"to_address": {"street_address": "201 Henderson Road",
"city": "Singapore",
"state": "string",
"country": "Singapore",
"zip_code": 159545,
"building_name": "Apex @ Henderson"
},
"to_time_window": {"start_timezone": "Asia/Singapore",
"start_time_utc": "2019-08-24T14:15:22Z",
"end_timezone": "Asia/Singapore",
"end_time_utc": "2019-08-24T14:15:22Z"
},
"version_seq": 0
}
]
},
"driver": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe"
}
},
"plan": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Runsheet Broadcast Plan"
},
"statuses": [{"current_state": "rejected",
"action": "system_rejected",
"reason": "string",
"expired_time": "2019-08-24T14:15:22Z",
"happened_at_utc": "2019-08-24T14:15:22Z",
"saved_at_utc": "2019-08-24T14:15:22Z"
}
]
}
]
}

Record the system creation of the runsheet broadcast pair

Only Runsheet Broadcast Record Worker is authorized.

Authorizations:

bearerAuth

Request Body schema: application/json

	object (pair)
	object (plan)
happened_at_utc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"pair": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"runsheet": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "My Runsheet",
"tasks": [{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"total_item_weight": 0,
"total_weight_unit": "string",
"total_item_volume": 0,
"total_volume_unit": "string",
"total_item_count": 0,
"client_time_utc": "2019-08-24T14:15:22Z",
"client_timezone": "Asia/Singapore",
"from_address": {"street_address": "201 Henderson Road",
"city": "Singapore",
"state": "string",
"country": "Singapore",
"zip_code": 159545,
"building_name": "Apex @ Henderson"
},
"from_time_window": {"start_timezone": "Asia/Singapore",
"start_time_utc": "2019-08-24T14:15:22Z",
"end_timezone": "Asia/Singapore",
"end_time_utc": "2019-08-24T14:15:22Z"
},
"to_address": {"street_address": "201 Henderson Road",
"city": "Singapore",
"state": "string",
"country": "Singapore",
"zip_code": 159545,
"building_name": "Apex @ Henderson"
},
"to_time_window": {"start_timezone": "Asia/Singapore",
"start_time_utc": "2019-08-24T14:15:22Z",
"end_timezone": "Asia/Singapore",
"end_time_utc": "2019-08-24T14:15:22Z"
}
}
]
},
"driver": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "John Doe"
}
},
"plan": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "My Runsheet Broadcast Plan"
},
"happened_at_utc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"message": "Successfully recorded pair creation."
}

Record the system deletion of the runsheet broadcast plan

Only Runsheet Broadcast Record Worker is authorized.

Authorizations:

bearerAuth

path Parameters

plan_id required	string <uuid> ID of the plan of the pair
pair_id required	string <uuid> ID of the pair which broadcast record needs to be updated

Request Body schema: application/json

happened_at_utc

string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"happened_at_utc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"message": "Successfully recorded pair deletion."
}

Record the system broadcast of the runsheet broadcast pair

Only Runsheet Broadcast Plan Worker is authorized.

Authorizations:

bearerAuth

path Parameters

plan_id required	string <uuid> ID of the plan of the pair
pair_id required	string <uuid> ID of the pair which broadcast record needs to be updated

Request Body schema: application/json

happened_at_utc

string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"happened_at_utc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"message": "Successfully recorded pair broadcast."
}

Record the driver acceptance of the runsheet broadcast pair

Only Runsheet Broadcast Plan Worker is authorized.

Authorizations:

bearerAuth

path Parameters

plan_id required	string <uuid> ID of the plan of the pair
pair_id required	string <uuid> ID of the pair which broadcast record needs to be updated

Request Body schema: application/json

happened_at_utc

string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"happened_at_utc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"message": "Successfully recorded acceptance by driver."
}

Record the driver rejection of the runsheet broadcast pair

Only Runsheet Broadcast Record Worker is authorized.

Authorizations:

bearerAuth

path Parameters

plan_id required	string <uuid> ID of the plan of the pair
pair_id required	string <uuid> ID of the pair which broadcast record needs to be updated

Request Body schema: application/json

happened_at_utc

string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"happened_at_utc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"message": "Successfully recorded rejection by driver."
}

Record the system rejection of the runsheet broadcast plan

Only Runsheet Broadcast Record Worker is authorized.

Authorizations:

bearerAuth

path Parameters

plan_id required	string <uuid> ID of the plan of the pair
pair_id required	string <uuid> ID of the pair which broadcast record needs to be updated

Request Body schema: application/json

reason	string or null
happened_at_utc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"reason": "string",
"happened_at_utc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"message": "Successfully recorded rejection by system."
}

Get unhandled pairs list for a driver

Only drivers are authorized.

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"pairs": [{"pair_id": "c7e25b7c-0395-4cfa-a7dc-6a225d16aa55",
"plan_id": "00713021-9aea-41da-9a88-87760c08fa72"
}
]
}