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

Remove real phone number from examples

Browse Source
This commit is contained in:
catherineheywood
2016-05-05 09:18:21 +01:00
parent 208bbbad31
commit b262039a5a
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/index.md
View File

@@ -236,7 +236,7 @@ The response (status code 200) will be:
{'notifications': {'notifications':
[{ [{
'status': 'delivered', 'status': 'delivered',
'to': '07515 349 060', 'to': '07515 987 456',
'template': {'id': '5e427b42-4e98-46f3-a047-32c4a87d26bb', 'template': {'id': '5e427b42-4e98-46f3-a047-32c4a87d26bb',
'name': 'First template', 'name': 'First template',
'template_type': 'sms'}, 'template_type': 'sms'},
@@ -254,7 +254,7 @@ The response (status code 200) will be:
}, },
{ {
'status': 'delivered', 'status': 'delivered',
'to': '07515 349 060', 'to': '07515 987 456',
'template': {'id': '5e427b42-4e98-46f3-a047-32c4a87d26bb', 'template': {'id': '5e427b42-4e98-46f3-a047-32c4a87d26bb',
'name': 'First template', 'name': 'First template',
'template_type': 'sms'}, 'template_type': 'sms'},
@@ -282,8 +282,10 @@ where:
* `status` is the the status of the notification; this can be `sending`, `delivered`, or `failed` * `status` is the the status of the notification; this can be `sending`, `delivered`, or `failed`
* `to` is the recipient's phone number or email address * `to` is the recipient's phone number or email address
* `name` is the name of the template used * `template`:
* `template_type` is `sms` or `email` * `id` is the template ID
* `name` is the name of the template used
* `template_type` is `sms` or `email`
* `created_at` is the full timestamp, in Coordinated Universal Time (UTC), at which GOV.UK Notify created the data object * `created_at` is the full timestamp, in Coordinated Universal Time (UTC), at which GOV.UK Notify created the data object
* `updated_at` is the full timestamp, in Coordinated Universal Time (UTC), at which the data object was updated * `updated_at` is the full timestamp, in Coordinated Universal Time (UTC), at which the data object was updated
* `sent_at` is the full timestamp, in Coordinated Universal Time (UTC), at which the notification was sent * `sent_at` is the full timestamp, in Coordinated Universal Time (UTC), at which the notification was sent