From b333b1bfb59b932a98e963f68779b79e570c0278 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:24:05 +0100 Subject: [PATCH 01/23] reword integrate info - table --- docs/index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 1a0ec5fb1..847b61f62 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,13 +54,14 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/

Integrate the GOV.UK Notify API into your service

-There are 2 ways to integrate the API into your service: +If you code in one of the languages in the table below, you can use one a client library provided by GOV.UK Notify to intergrate the API into your service: -* use one of the client libraries provided by GOV.UK Notify (see the Usage section in the Readme files): - * [Python library](https://github.com/alphagov/notifications-python-client) - * [PHP library](https://github.com/alphagov/notifications-php-client) - * [Java library](https://github.com/alphagov/notifications-java-client) -* develop your own integration to produce requests in the correct format +Lanuguage | Library | +Python | [Link to coding examples](https://github.com/alphagov/notifications-python-client) +PHP | [Link to coding examples](https://github.com/alphagov/notifications-php-client) +Jave | [Link to coding examples](https://github.com/alphagov/notifications-java-client) + +If you code in a different language you need to develop your own integration to produce requests in the correct format.

Authenticate requests

From c4efdbe925153b8fa45204d4ac302b45ad01ea71 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:25:59 +0100 Subject: [PATCH 02/23] correct table --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 847b61f62..92cd33e7b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,7 +56,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/ If you code in one of the languages in the table below, you can use one a client library provided by GOV.UK Notify to intergrate the API into your service: -Lanuguage | Library | +Lanuguage | Library Python | [Link to coding examples](https://github.com/alphagov/notifications-python-client) PHP | [Link to coding examples](https://github.com/alphagov/notifications-php-client) Jave | [Link to coding examples](https://github.com/alphagov/notifications-java-client) From f6053690b3e531782072b69ac134b8789cc70043 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:27:50 +0100 Subject: [PATCH 03/23] correct table2 --- docs/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.md b/docs/index.md index 92cd33e7b..562f9b7cb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,6 +56,9 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/ If you code in one of the languages in the table below, you can use one a client library provided by GOV.UK Notify to intergrate the API into your service: + +Lanuguage | Library +--- | --- Lanuguage | Library Python | [Link to coding examples](https://github.com/alphagov/notifications-python-client) PHP | [Link to coding examples](https://github.com/alphagov/notifications-php-client) From 509d2d095c2dbc85b392aa2ae21a7f2d269825dd Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:28:45 +0100 Subject: [PATCH 04/23] correct table3 --- docs/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 562f9b7cb..beccb99bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,10 +59,9 @@ If you code in one of the languages in the table below, you can use one a client Lanuguage | Library --- | --- -Lanuguage | Library -Python | [Link to coding examples](https://github.com/alphagov/notifications-python-client) -PHP | [Link to coding examples](https://github.com/alphagov/notifications-php-client) -Jave | [Link to coding examples](https://github.com/alphagov/notifications-java-client) +Python | [Link to Python library coding examples](https://github.com/alphagov/notifications-python-client) +PHP | [Link to PHP library coding examples](https://github.com/alphagov/notifications-php-client) +Java | [Link to Java library coding examples](https://github.com/alphagov/notifications-java-client) If you code in a different language you need to develop your own integration to produce requests in the correct format. From 6b5b952694ab4203a7ead08f3134b559481fd5de Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:29:51 +0100 Subject: [PATCH 05/23] rewording --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index beccb99bd..eddc718af 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,7 +54,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/

Integrate the GOV.UK Notify API into your service

-If you code in one of the languages in the table below, you can use one a client library provided by GOV.UK Notify to intergrate the API into your service: +If you code in one of the languages listed below, you can use one a client library provided by GOV.UK Notify to intergrate the API into your service: Lanuguage | Library From 375c7a0b9f3108d439fabe6e97dc9a8c1b46aab9 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:30:28 +0100 Subject: [PATCH 06/23] rewording --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index eddc718af..dc5a8190e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,7 +54,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/

Integrate the GOV.UK Notify API into your service

-If you code in one of the languages listed below, you can use one a client library provided by GOV.UK Notify to intergrate the API into your service: +If you code in one of the languages listed below, you can use one a client library provided by GOV.UK Notify to intergrate the GOV.UK Notify API into your service: Lanuguage | Library From d2902b0b3c4e992d30870fdff6c8ab6649962655 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:31:11 +0100 Subject: [PATCH 07/23] rewording --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index dc5a8190e..7e1c577f9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,7 +54,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/

Integrate the GOV.UK Notify API into your service

-If you code in one of the languages listed below, you can use one a client library provided by GOV.UK Notify to intergrate the GOV.UK Notify API into your service: +If you code in one of the languages listed below, you can use a client library provided by GOV.UK Notify to intergrate the GOV.UK Notify API into your service: Lanuguage | Library From 58dd6f8729049f2fe7054989ffc95a4f86f934e3 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:32:13 +0100 Subject: [PATCH 08/23] correct typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 7e1c577f9..4ca67771f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,7 +57,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/ If you code in one of the languages listed below, you can use a client library provided by GOV.UK Notify to intergrate the GOV.UK Notify API into your service: -Lanuguage | Library +Language | Library --- | --- Python | [Link to Python library coding examples](https://github.com/alphagov/notifications-python-client) PHP | [Link to PHP library coding examples](https://github.com/alphagov/notifications-php-client) From a9fbb73ad1d40c31d65100c56e7c70953db526bb Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:33:13 +0100 Subject: [PATCH 09/23] add comma --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4ca67771f..7dca29a57 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,7 +54,7 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/

Integrate the GOV.UK Notify API into your service

-If you code in one of the languages listed below, you can use a client library provided by GOV.UK Notify to intergrate the GOV.UK Notify API into your service: +If you code in one of the languages listed below, you can use a client library provided by GOV.UK Notify to integrate the GOV.UK Notify API into your service: Language | Library @@ -63,7 +63,7 @@ Python | [Link to Python library coding examples](https://github.com/alphagov/no PHP | [Link to PHP library coding examples](https://github.com/alphagov/notifications-php-client) Java | [Link to Java library coding examples](https://github.com/alphagov/notifications-java-client) -If you code in a different language you need to develop your own integration to produce requests in the correct format. +If you code in a different language, you need to develop your own integration to produce requests in the correct format.

Authenticate requests

From 7d0e8d9719827ac14c4d71ae7e3f1515d1b1c681 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:44:09 +0100 Subject: [PATCH 10/23] add list of query string parameters --- docs/index.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7dca29a57..420d2cf7a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -302,8 +302,14 @@ where: * `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 * `links`: - * `last` is the url of the last page of notifications - * `next` is the url of the next page of notifications + * `last` is the URL of the last page of notifications + * `next` is the URL of the next page of notifications + These URLs accept the following query string parameters: + * `template_type` + * `status` + * `page` + * `page_size` + * `limit_days` * `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 From 92ab4e356d8bd98288e09d881bc0d28fbe602a01 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:45:12 +0100 Subject: [PATCH 11/23] formatting --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 420d2cf7a..46f066cda 100644 --- a/docs/index.md +++ b/docs/index.md @@ -304,6 +304,7 @@ where: * `links`: * `last` is the URL of the last page of notifications * `next` is the URL of the next page of notifications + These URLs accept the following query string parameters: * `template_type` * `status` From 2b5f881d4453e4ceaa965c2de94172e2051aeace Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:45:59 +0100 Subject: [PATCH 12/23] formatting2 --- docs/index.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index 46f066cda..25b0a43d7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -305,12 +305,12 @@ where: * `last` is the URL of the last page of notifications * `next` is the URL of the next page of notifications - These URLs accept the following query string parameters: - * `template_type` - * `status` - * `page` - * `page_size` - * `limit_days` + These URLs accept the following query string parameters: + * `template_type` + * `status` + * `page` + * `page_size` + * `limit_days` * `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 From 9e647be35ce12cbffc10813f85d9408c2a3dd9d9 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:49:32 +0100 Subject: [PATCH 13/23] explanations of queryparams --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 25b0a43d7..7fe7996c8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -306,11 +306,11 @@ where: * `next` is the URL of the next page of notifications These URLs accept the following query string parameters: - * `template_type` - * `status` - * `page` + * `template_type` - `sms` or `email` (you can enter both) + * `status` - `sending`, `delivered`, or `failed` + * `page` - page number * `page_size` - * `limit_days` + * `limit_days` - defaults to 7 * `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 From 353346882c58561af4b5a7c64b3a01f5c5befc83 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:55:19 +0100 Subject: [PATCH 14/23] explanations of queryparams2 --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7fe7996c8..bf51c249f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -309,8 +309,8 @@ where: * `template_type` - `sms` or `email` (you can enter both) * `status` - `sending`, `delivered`, or `failed` * `page` - page number - * `page_size` - * `limit_days` - defaults to 7 + * `page_size` - number of notifications per page; defaults to 50 + * `limit_days` - number of days; defaults to 7 * `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 From 384049585b6a596abab611e9f98c9e785f3605c8 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Thu, 19 May 2016 14:56:18 +0100 Subject: [PATCH 15/23] explanations of queryparams3 --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index bf51c249f..9e9585658 100644 --- a/docs/index.md +++ b/docs/index.md @@ -306,7 +306,7 @@ where: * `next` is the URL of the next page of notifications These URLs accept the following query string parameters: - * `template_type` - `sms` or `email` (you can enter both) + * `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 From 82dcf916ff43e20a666670a9aff0e66c830ec754 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:29:33 +0100 Subject: [PATCH 16/23] restore list of libraries --- docs/index.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9e9585658..6b1fa8898 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,16 +54,13 @@ To find out more about GOV.UK Notify, see the [Government as a Platform](https:/

Integrate the GOV.UK Notify API into your service

-If you code in one of the languages listed below, you can use a client library provided by GOV.UK Notify to integrate the GOV.UK Notify API into your service: +There are 2 ways to integrate the API into your service: - -Language | Library ---- | --- -Python | [Link to Python library coding examples](https://github.com/alphagov/notifications-python-client) -PHP | [Link to PHP library coding examples](https://github.com/alphagov/notifications-php-client) -Java | [Link to Java library coding examples](https://github.com/alphagov/notifications-java-client) - -If you code in a different language, you need to develop your own integration to produce requests in the correct format. +* use one of the client libraries provided by GOV.UK Notify (see the Usage section in the Readme files): + * [Python library](https://github.com/alphagov/nnotifications-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) +* develop your own integration to produce requests in the correct format

Authenticate requests

From 52742029377a7a17b84176fecaecd21a9a4ab225 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:30:52 +0100 Subject: [PATCH 17/23] typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 6b1fa8898..82b9629fc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,7 +57,7 @@ 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: * use one of the client libraries provided by GOV.UK Notify (see the Usage section in the Readme files): - * [Python library](https://github.com/alphagov/nnotifications-python-client/blob/master/README.md#usage) + * [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) * develop your own integration to produce requests in the correct format From 0f783f87d082f9f1d62de7e735a7854ddcf7db68 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:32:31 +0100 Subject: [PATCH 18/23] linkswithinreadmes --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 82b9629fc..689064749 100644 --- a/docs/index.md +++ b/docs/index.md @@ -56,9 +56,9 @@ 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: -* use one of the client libraries provided by GOV.UK Notify (see the Usage section in the Readme files): - * [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) +* use one of the client libraries provided by GOV.UK Notify: + * Python library - [link to coding examples](https://github.com/alphagov/notifications-python-client/blob/master/README.md#usage) + * PHP library [link to coding examples](https://github.com/alphagov/notifications-php-client/blob/master/README.md#usage) * [Java library](https://github.com/alphagov/notifications-java-client) * develop your own integration to produce requests in the correct format From 2a58454c7c7e9e5bd6d8e6ce94ab87a9ab1196fa Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:34:39 +0100 Subject: [PATCH 19/23] linkswithinreadmes --- docs/index.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 689064749..9c2d10497 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,9 +57,11 @@ 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: * use one of the client libraries provided by GOV.UK Notify: - * Python library - [link to coding examples](https://github.com/alphagov/notifications-python-client/blob/master/README.md#usage) - * PHP library [link to coding examples](https://github.com/alphagov/notifications-php-client/blob/master/README.md#usage) + + * [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) + * develop your own integration to produce requests in the correct format

Authenticate requests

From a4b2738e530051158f7d79e4ec8076e1de8e7555 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:40:44 +0100 Subject: [PATCH 20/23] move querystringparams --- docs/index.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9c2d10497..ff37e090e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -303,24 +303,26 @@ where: * `links`: * `last` is the URL of the last page of notifications * `next` is the URL of the next page of notifications - - These URLs accept 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 * `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 The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above. -This list is split into pages. To scroll through the pages run: +You can adapt the ``GET/notifications`` command with 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 + + +For example, to scroll through the pages in the list, run: ``` -GET /notifications?&page=2 +GET /notifications?page=2 ``` +

Authorisation error messages

From dea0e5a31b50572b01fb56732fd5168373855a0c Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:45:25 +0100 Subject: [PATCH 21/23] typo --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index ff37e090e..b8320c142 100644 --- a/docs/index.md +++ b/docs/index.md @@ -308,7 +308,7 @@ where: The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above. -You can adapt the ``GET/notifications`` command with the following query string parameters: +You can adapt the ``GET /notifications`` command with the following query string parameters: * `template_type` - `sms` or `email` (you can enter `template_type` twice) * `status` - `sending`, `delivered`, or `failed` * `page` - page number From 06cee32a43e4a4ef9bc24d23c848a04a49c42adb Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:48:34 +0100 Subject: [PATCH 22/23] change command to request --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index b8320c142..38c2c42dc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -308,7 +308,7 @@ where: The above fields are populated once the message has been processed; initially you get back the [response](#coderesponse) indicated above. -You can adapt the ``GET /notifications`` command with the following query string parameters: +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 From 5fed199696e9903e3e35394c59f28f2e2aeb3745 Mon Sep 17 00:00:00 2001 From: Catherine Heywood Date: Mon, 23 May 2016 10:49:14 +0100 Subject: [PATCH 23/23] remove redundant sentence --- docs/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 38c2c42dc..5be0824ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -306,8 +306,6 @@ where: * `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 -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`