darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2025-12-10 23:23:27 -05:00
Code Issues Packages Projects Releases Wiki Activity

move querystringparams

Browse Source
This commit is contained in:
Catherine Heywood
2016-05-23 10:40:44 +01:00
parent 2a58454c7c
commit a4b2738e53
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/index.md
View File

@@ -303,24 +303,26 @@ where:
* `links`:
* `last` is the URL of the last page of notifications
* `next` is the URL of the next page of notifications
These URLs accept the following query string parameters:
* `template_type` - `sms` or `email` (you can enter `template_type` twice)
* `status` - `sending`, `delivered`, or `failed`
* `page` - page number
* `page_size` - number of notifications per page; defaults to 50
* `limit_days` - number of days; defaults to 7
* `total` is the total number of notifications sent by the service using the given template type
* `page_size` is an optional integer indicating the number of notifications per page; if not provided, defaults to 50
The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above.
This list is split into pages. To scroll through the pages run:
You can adapt the ``GET/notifications`` command with the following query string parameters:
* `template_type` - `sms` or `email` (you can enter `template_type` twice)
* `status` - `sending`, `delivered`, or `failed`
* `page` - page number
* `page_size` - number of notifications per page; defaults to 50
* `limit_days` - number of days; defaults to 7
For example, to scroll through the pages in the list, run:
```
GET /notifications?&page=2
GET /notifications?page=2
```
<h3 id="autherror_code">Authorisation error messages</h3>