List Alert Recipients
Pending
GET
https://api.mpc.dev.placewise.com/v1/operations/alerts/{id}/recipients
API Permit:Operations:Api:AlertRecipients:List
API Context:Loyalty Club
Authorizations:UserToken
Body Parameters
DocumentRecipient example:
{
"id": 137,
"member_id": 46849981,
"delivery_status": "delivered",
"report_status": "safe",
"reported_at": "2021-05-15T12:05:15.639Z",
"last_seen_at": "2021-05-15T12:06:02.470Z",
"created_at": "2021-05-15T11:41:03.574Z",
"updated_at": "2021-05-15T12:06:02.471Z"
}| Key | Type | Optional | Description |
|---|---|---|---|
| id | integer | no | |
| member_id | integer | no | ID of MPC member |
| delivery_status | enum: ['pending', 'delivered', 'failed'] | no | Describes if member has received actual message |
| report_status | enum: ['safe', 'need_help'] | yes | Status reported by member |
| reported_at | datetime | yes | Time of report |
| last_seen_at | datetime | yes | Last time when the recipient retrieved the Alert record |
| created_at | datetime | no | Time of creation |
| updated_at | datetime | no | Time of last update |
URL Parameters
| Parameter | Type | Description |
|---|---|---|
| id | integer | Alert ID |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| per_page | integer | 100 | Number of results to be returned per request (100 is the maximum) |
| page_no | integer | 1 | Number of results page |
Error Responses
| Status | Description |
|---|---|
404 | Alert not found |
Example
{
"alert_recipients": [], // List of alert recipients
"pagination_info": {} // Pagination info - see 'Pagination info'
}Request
Path Params
Header Params