Retrieve all Logs for a Loyalty / Gift Card Activation request. This endpoint accepts several query parameters to filter the data returned. Data will be returned chronologically.
GET ~/loyalty/cards/activation/:request-id/logs?action=card_activate
Headers
| Field | Type | Description |
|---|---|---|
| Authorization | String |
Bearer authentication token prefixed with |
| Content-Type | String |
Request content type, must be 'application/json' |
| vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Parameters
| Field | Type | Description |
|---|---|---|
| :request-id | String |
The ID of the card activation request to retrieve the audit logs for |
| actionoptional | String |
The action that you are interested to see the logs for. Defaults to accepting all. |
| fromoptional | Integer |
The date and time (seconds since Epoch) <= Log's |
| tooptional | Integer |
The date and time (seconds since Epoch) >= Log's |
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 made |
| deviceName | String |
A name for the device at which the request was made |
| area | Boolean |
The area at which the request was made (e.g. Bar, Restaurant, Lounge, etc) |
| appId | Boolean |
ID identifying the App that originally created this order. Will not return if not set. |
| appName | Boolean |
The name of the App that originally created this order. Will not return if not set. |
| 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",
"appId": "12",
"appName": "Fred's Cool Gift Card App",
"action": [
"card_activate"
],
"audit": "accepted => cancelled",
"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",
"appId": "12",
"appName": "Fred's Cool Gift Card App",
"action": ["card_activate"],
"performedAt": "2018-08-16T03:58:38.485Z"
}
]
Comments
0 comments
Please sign in to leave a comment.