Retrieve all Logs for a Reservation
GET ~/bookings/:booking-id/logs
Parameters
| Field | Type | Description |
|---|---|---|
| :booking-id | String |
The ID of the booking you'd like to retrieve logs for |
Response
| Field | Type | Description |
|---|---|---|
| logId | String |
Unique id identifying the log record |
| employeeId | String |
A Doshii employeeId for the employee making the action |
| employeeName | String |
The name of the employee making the action |
| employeePosRef | String |
A POS reference for the employee making the action |
| deviceRef | String |
An internal reference for the device at which the request was actioned |
| deviceName | String |
A name for the device at which the request was actioned |
| area | String |
The area at which the request was actioned (e.g. Bar, Restaurant, Lounge, etc) |
| audit | String |
Describes state transition of order if occurred during this action. Will not return if no status change. |
| action | Array |
A list of actions performed |
| performedAt | String |
Date when the action was performed |
Examples
Response
[
{
"logId": "f52e2b12-9b13-4113-bb49-3cfacad02545",
"employeeId": "1",
"employeeName": "Fred Bloggs",
"employeePosRef": "432324tgr",
"deviceRef": "213-iPad",
"deviceName": "Dining Room iPad 1",
"area": "Dining Room",
"action": [
"booking_updated"
],
"audit": "accepted => arrived",
"performedAt": "2018-08-16T04:58:38.485Z"
},
{
"logId": "e34cc5e6-ea59-48c4-bd2f-d14b3b8dbdf3",
"employeeId": "1",
"employeeName": "Fred Bloggs",
"employeePosRef": "432324tgr",
"deviceRef": "213-iPad",
"deviceName": "Dining Room iPad 1",
"area": "Dining Room",
"action": ["booking_created"],
"performedAt": "2018-08-16T03:58:38.485Z"
}
]
Comments
0 comments
Please sign in to leave a comment.