darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-05-03 07:31:28 -04:00
Code Issues Packages Projects Releases Wiki Activity

add list of query string parameters

Browse Source
This commit is contained in:
Catherine Heywood
2016-05-19 14:44:09 +01:00
parent a9fbb73ad1
commit 7d0e8d9719
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/index.md
View File

@@ -302,8 +302,14 @@ where:
* `reference` is used in the Notifications API so you can ignore it (populated for email notifications only)
* `sent_by` is the name of the provider
* `links`:
* `last` is the url of the last page of notifications
* `next` is the url of the next page of notifications
* `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`
* `status`
* `page`
* `page_size`
* `limit_days`
* `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