darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-09-04 17:58:25 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #600 from alphagov/docIntegrateInfo

Browse Source 
Doc integrate info
This commit is contained in:
catherineheywood
2016-05-24 10:12:36 +01:00
parent a4db2dcfe9 5fed199696
commit 3a379017d9
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/index.md
View File

@@ -56,10 +56,12 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/
There are 2 ways to integrate the API into your service: There are 2 ways to integrate the API into your service:
* use one of the client libraries provided by GOV.UK Notify (see the Usage section in the Readme files): * use one of the client libraries provided by GOV.UK Notify:
* [Python library](https://github.com/alphagov/notifications-python-client)
* [PHP library](https://github.com/alphagov/notifications-php-client) * [Python library](https://github.com/alphagov/notifications-python-client/blob/master/README.md#usage)
* [PHP library](https://github.com/alphagov/notifications-php-client/blob/master/README.md#usage)
* [Java library](https://github.com/alphagov/notifications-java-client) * [Java library](https://github.com/alphagov/notifications-java-client)
* develop your own integration to produce requests in the correct format * develop your own integration to produce requests in the correct format
<h3 id="AuthRequests">Authenticate requests</h3> <h3 id="AuthRequests">Authenticate requests</h3>
@@ -299,19 +301,26 @@ where:
* `reference` is used in the Notifications API so you can ignore it (populated for email notifications only) * `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 * `sent_by` is the name of the provider
* `links`: * `links`:
* `last` is the url of the last page of notifications * `last` is the URL of the last page of notifications
* `next` is the url of the next page of notifications * `next` is the URL of the next page of notifications
* `total` is the total number of notifications sent by the service using the given template type * `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 * `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. The ``GET /notifications`` request accepts 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
This list is split into pages. To scroll through the pages run:
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> <h3 id="autherror_code">Authorisation error messages</h3>