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

Merge pull request #562 from alphagov/standardise-coding-examples

Browse Source 
Docs: tidy up indentation in JSON examples
This commit is contained in:
minglis
2016-05-13 09:00:32 +01:00
parent d160061408 8e85b22157
commit cccf2c4590
1 changed files with 99 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/index.md
View File

@@ -190,18 +190,21 @@ The response (status code 200) will be:
``` ```
{ {
'notification': 'notification': {
{
'status': 'delivered', 'status': 'delivered',
'to': '07515 987 456', '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'
},
'created_at': '2016-04-26T15:29:36.891512+00:00', 'created_at': '2016-04-26T15:29:36.891512+00:00',
'updated_at': '2016-04-26T15:29:38.724808+00:00', 'updated_at': '2016-04-26T15:29:38.724808+00:00',
'sent_at': '2016-04-26T15:29:37.230976+00:00', 'sent_at': '2016-04-26T15:29:37.230976+00:00',
'job': {'id': 'f9043884-acac-46db-b2ea-f08cd8ec6d67', 'job': {
'original_file_name': 'Test run'}, 'id': 'f9043884-acac-46db-b2ea-f08cd8ec6d67',
'original_file_name': 'Test run'
},
'sent_at': '2016-04-26T15:29:37.230976+00:00', 'sent_at': '2016-04-26T15:29:37.230976+00:00',
'id': 'f163deaf-2d3f-4ec6-98fc-f23fa511518f', 'id': 'f163deaf-2d3f-4ec6-98fc-f23fa511518f',
'content_char_count': 490, 'content_char_count': 490,
@@ -226,16 +229,20 @@ The response (status code 200) will be:
[{ [{
'status': 'delivered', 'status': 'delivered',
'to': '07515 987 456', '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'
'job': {'id': '5cc9d7ae-ceb7-4565-8345-4931d71f8c2e', },
'original_file_name': 'Test run'}, 'job': {
'id': '5cc9d7ae-ceb7-4565-8345-4931d71f8c2e',
'original_file_name': 'Test run'
},
'created_at': '2016-04-26T15:30:49.968969+00:00', 'created_at': '2016-04-26T15:30:49.968969+00:00',
'updated_at': '2016-04-26T15:30:50.853844+00:00', 'updated_at': '2016-04-26T15:30:50.853844+00:00',
'sent_at': '2016-04-26T15:30:50.383634+00:00', 'sent_at': '2016-04-26T15:30:50.383634+00:00',
'id': '04ae9bdc-92aa-4d6c-a0da-48587c03d4c7', 'id': '04ae9bdc-92aa-4d6c-a0da-48587c03d4c7',
'content_char_count': 446 'content_char_count': 446,
'service': '5cf87313-fddd-4482-a2ea-48e37320efd1', 'service': '5cf87313-fddd-4482-a2ea-48e37320efd1',
'reference': None, 'reference': None,
'sent_by': 'mmg' 'sent_by': 'mmg'
@@ -243,11 +250,15 @@ The response (status code 200) will be:
{ {
'status': 'delivered', 'status': 'delivered',
'to': '07515 987 456', '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'
'job': {'id': 'f9043884-acac-46db-b2ea-f08cd8ec6d67', },
'original_file_name': 'Test run'}, 'job': {
'id': 'f9043884-acac-46db-b2ea-f08cd8ec6d67',
'original_file_name': 'Test run'
},
'created_at': '2016-04-26T15:29:36.891512+00:00', 'created_at': '2016-04-26T15:29:36.891512+00:00',
'updated_at': '2016-04-26T15:29:38.724808+00:00', 'updated_at': '2016-04-26T15:29:38.724808+00:00',
'sent_at': '2016-04-26T15:29:37.230976+00:00', 'sent_at': '2016-04-26T15:29:37.230976+00:00',
@@ -257,10 +268,12 @@ The response (status code 200) will be:
'reference': None, 'reference': None,
'sent_by': 'mmg' 'sent_by': 'mmg'
}, },
... …
] ],
'links': {'last': '/notifications?page=3&template_type=sms&status=delivered', 'links': {
'next': '/notifications?page=2&template_type=sms&status=delivered'}, 'last': '/notifications?page=3&template_type=sms&status=delivered',
'next': '/notifications?page=2&template_type=sms&status=delivered'
},
'total': 162, 'total': 162,
'page_size': 50 'page_size': 50
} }
@@ -326,9 +339,3 @@ Error code | Body | Meaning
The GOV.UK Notify API code is open sourced at: The GOV.UK Notify API code is open sourced at:
[GOV.UK Notify API](https://github.com/alphagov/notifications-api) [GOV.UK Notify API](https://github.com/alphagov/notifications-api)