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

Add titles to API endpoints section

Browse Source
This commit is contained in:
catherineheywood
2016-05-05 09:25:52 +01:00
parent b262039a5a
commit b9cd3a7936
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/index.md
View File

@@ -124,7 +124,7 @@ GOV.UK Notify supports the following client libraries:
These provide example code for calling the API and for creating API tokens. These provide example code for calling the API and for creating API tokens.
<a name="API_endpoints"></a> <a name="API_endpoints"></a>
### API endpoints ## API endpoints
You can use the GOV.UK Notify API to: You can use the GOV.UK Notify API to:
@@ -132,6 +132,9 @@ You can use the GOV.UK Notify API to:
* [retrieve the status of one notification](#get_single_notif) * [retrieve the status of one notification](#get_single_notif)
* [retrieve the status of all notifications](#get_all_notif) * [retrieve the status of all notifications](#get_all_notif)
<a name="sendnotifications"></a>
### Send notifications
<a name="sendsms"></a> <a name="sendsms"></a>
To send an sms notification: To send an sms notification:
``` ```
@@ -192,6 +195,9 @@ The response (status code 201) will be:
where `id` is the unique identifier for the notification – you'll use this id to retrieve the status of a notification. where `id` is the unique identifier for the notification – you'll use this id to retrieve the status of a notification.
<a name="getnotifications"></a>
### Retrieve notifications
<a name="get_single_notif"></a> <a name="get_single_notif"></a>
To retrieve the status of a single sms or email notification: To retrieve the status of a single sms or email notification:
``` ```
@@ -312,7 +318,7 @@ GET /notifications?&page=2
``` ```
<a name="autherror_code"></a> <a name="autherror_code"></a>
## Authorisation error messages ### Authorisation error messages
Error code | Body | Meaning Error code | Body | Meaning
--- | --- | --- --- | --- | ---
@@ -322,7 +328,7 @@ Error code | Body | Meaning
403 | {"result": "error", "message": "Invalid credentials"} | Unable to find Service ID that was sent in the iss claim, no valid API for Service ID 403 | {"result": "error", "message": "Invalid credentials"} | Unable to find Service ID that was sent in the iss claim, no valid API for Service ID
403 | {"result": "error", "message": "Invalid token: expired"} | Token is expired; there is a 30 second time limit 403 | {"result": "error", "message": "Invalid token: expired"} | Token is expired; there is a 30 second time limit
## Other error messages ### Other error messages
Error code | Body | Meaning Error code | Body | Meaning
--- | --- | --- --- | --- | ---
@@ -333,7 +339,7 @@ Error code | Body | Meaning
<a name="Notify_code"></a> <a name="Notify_code"></a>
### GOV.UK Notify API code ## GOV.UK Notify API code
The GOV.UK Notify API code is open sourced at: The GOV.UK Notify API code is open sourced at: