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

Improve navigation

Browse Source 
Create links from bullet list in API endpoints section down to 'POST' and 'GET' examples.
This commit is contained in:
catherineheywood
2016-04-26 10:41:07 +01:00
parent 9984b04b6f
commit a554d06c1d
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/index.md
View File

@@ -119,11 +119,12 @@ These provide example code for calling the API and for constructing the API toke
You can use the GOV.UK Notify API to: You can use the GOV.UK Notify API to:
* send a notification * send an [sms](#sendsms) or [email](#sendemail) notification
* retrieve one notification * [retrieve the status of one notification](#get_single_notif)
* retrieve all notifications * [retrieve the status of all notifications](#get_all_notif)
To send a text notification: <a name="sendsms"></a>
To send an sms notification:
``` ```
POST /notifications/sms POST /notifications/sms
``` ```
@@ -138,6 +139,7 @@ POST /notifications/sms
} }
} }
``` ```
<a name="sendemail"></a>
To send an email notification: To send an email notification:
``` ```
POST /notifications/email POST /notifications/email
@@ -179,7 +181,8 @@ The response will be:
where `id` is the unique identifier for the notification – you will use this id to retrieve the status of a notification. where `id` is the unique identifier for the notification – you will use this id to retrieve the status of a notification.
To retrieve the status of a single text or email notification: <a name="get_single_notif"></a>
To retrieve the status of a single sms or email notification:
``` ```
GET /notifications/{id} GET /notifications/{id}
``` ```
@@ -213,7 +216,8 @@ where:
The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above. The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above.
To get the status of all notifications: <a name="get_all_notif"></a>
To retrieve the status of all notifications:
``` ```
GET /notifications GET /notifications
``` ```