From b5eb103874350e915e193b4269fd8563c226cc4d Mon Sep 17 00:00:00 2001 From: Aidan Saunders Date: Wed, 16 Sep 2020 12:13:43 +0100 Subject: [PATCH 1/4] Update wp-rest.md Typos --- docs/api/v3/wp-rest.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/api/v3/wp-rest.md b/docs/api/v3/wp-rest.md index f8dd3cc8..a32d9bcb 100644 --- a/docs/api/v3/wp-rest.md +++ b/docs/api/v3/wp-rest.md @@ -18,9 +18,9 @@ Requirements: - `api_key` - **required**, the contact api key - `entity` - **required**, the API entity - `action` - **required**, the API action - - `json` - **optional**, json formatted string with the API parameters/argumets, or `1` as in `json=1` + - `json` - **optional**, json formatted string with the API parameters/arguments, or `1` as in `json=1` - It mimics CiviCRM's REST [interface](../interfaces.md), by default all calls to `civicrm/v3/rest` return XML formatted results, to get `json` formatted result pass `json=1` or a json formatted string with the API parameters, like in the example 2 below. + It mimics CiviCRM's REST [interface](../interfaces.md), by default all calls to `civicrm/v3/rest` return XML formatted results. To get `json` formatted result pass `json=1` or a json formatted string with the API parameters, like in example 2 below. **Examples**: @@ -28,27 +28,27 @@ Requirements: 2. `https://example.com/wp-json/civicrm/v3/rest?entity=Contact&action=get&key=&api_key=&json={"group": "Administrators"}` -2. `civicrm/v3/url` - a substition for `civicrm/extern/url.php` mailing tracking +2. `civicrm/v3/url` - a substitution for `civicrm/extern/url.php` mailing tracking -3. `civicrm/v3/open` - a substition for `civicrm/extern/open.php` mailing tracking +3. `civicrm/v3/open` - a substitution for `civicrm/extern/open.php` mailing tracking -4. `civicrm/v3/authorizeIPN` - a substition for `civicrm/extern/authorizeIPN.php` (for testing Authorize.net as per [docs](https://docs.civicrm.org/sysadmin/en/latest/setup/payment-processors/authorize-net/#shell-script-testing-method)) +4. `civicrm/v3/authorizeIPN` - a substitution for `civicrm/extern/authorizeIPN.php` (for testing Authorize.net as per [docs](https://docs.civicrm.org/sysadmin/en/latest/setup/payment-processors/authorize-net/#shell-script-testing-method)) **_Note_**: this endpoint has **not been tested** -5. `civicrm/v3/ipn` - a substition for `civicrm/extern/ipn.php` (for PayPal Standard and Pro live transactions) +5. `civicrm/v3/ipn` - a substitution for `civicrm/extern/ipn.php` (for PayPal Standard and Pro live transactions) **_Note_**: this endpoint has **not been tested** -6. `civicrm/v3/cxn` - a substition for `civicrm/extern/cxn.php` +6. `civicrm/v3/cxn` - a substitution for `civicrm/extern/cxn.php` -7. `civicrm/v3/pxIPN` - a substition for `civicrm/extern/pxIPN.php` +7. `civicrm/v3/pxIPN` - a substitution for `civicrm/extern/pxIPN.php` **_Note_**: this endpoint has **not been tested** -8. `civicrm/v3/widget` - a substition for `civicrm/extern/widget.php` +8. `civicrm/v3/widget` - a substitution for `civicrm/extern/widget.php` -9. `civicrm/v3/soap` - a substition for `civicrm/extern/soap.php` +9. `civicrm/v3/soap` - a substitution for `civicrm/extern/soap.php` **_Note_**: this endpoint has **not been tested** From 2c0d13b8600ce548e25830fedd0d278fe86a8183 Mon Sep 17 00:00:00 2001 From: Aidan Saunders Date: Fri, 18 Sep 2020 10:45:37 +0100 Subject: [PATCH 2/4] Update docs/api/v3/wp-rest.md Co-authored-by: Mikey O'Toole --- docs/api/v3/wp-rest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/v3/wp-rest.md b/docs/api/v3/wp-rest.md index a32d9bcb..75318c45 100644 --- a/docs/api/v3/wp-rest.md +++ b/docs/api/v3/wp-rest.md @@ -20,7 +20,7 @@ Requirements: - `action` - **required**, the API action - `json` - **optional**, json formatted string with the API parameters/arguments, or `1` as in `json=1` - It mimics CiviCRM's REST [interface](../interfaces.md), by default all calls to `civicrm/v3/rest` return XML formatted results. To get `json` formatted result pass `json=1` or a json formatted string with the API parameters, like in example 2 below. + It mimics CiviCRM's REST [interface](../interfaces.md), by default all calls to `civicrm/v3/rest` return XML formatted results. To get `json` formatted results pass `json=1` or a json formatted string with the API parameters, like in example 2 below. **Examples**: From 5bfb87fe629eb5f8bb7d3f7785bc3566fe4a4993 Mon Sep 17 00:00:00 2001 From: Aidan Saunders Date: Fri, 18 Sep 2020 10:45:56 +0100 Subject: [PATCH 3/4] Update docs/api/v3/wp-rest.md Co-authored-by: Mikey O'Toole --- docs/api/v3/wp-rest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/v3/wp-rest.md b/docs/api/v3/wp-rest.md index 75318c45..8ec71341 100644 --- a/docs/api/v3/wp-rest.md +++ b/docs/api/v3/wp-rest.md @@ -28,7 +28,7 @@ Requirements: 2. `https://example.com/wp-json/civicrm/v3/rest?entity=Contact&action=get&key=&api_key=&json={"group": "Administrators"}` -2. `civicrm/v3/url` - a substitution for `civicrm/extern/url.php` mailing tracking +2. `civicrm/v3/url` - a substitution for `civicrm/extern/url.php` to track when links in mailings are clicked. 3. `civicrm/v3/open` - a substitution for `civicrm/extern/open.php` mailing tracking From 0caa9fb4f92caa36ed69e4b43add97976c9482e7 Mon Sep 17 00:00:00 2001 From: Aidan Saunders Date: Fri, 18 Sep 2020 10:46:19 +0100 Subject: [PATCH 4/4] Update docs/api/v3/wp-rest.md Co-authored-by: Mikey O'Toole --- docs/api/v3/wp-rest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/v3/wp-rest.md b/docs/api/v3/wp-rest.md index 8ec71341..f16f8e1c 100644 --- a/docs/api/v3/wp-rest.md +++ b/docs/api/v3/wp-rest.md @@ -30,7 +30,7 @@ Requirements: 2. `civicrm/v3/url` - a substitution for `civicrm/extern/url.php` to track when links in mailings are clicked. -3. `civicrm/v3/open` - a substitution for `civicrm/extern/open.php` mailing tracking +3. `civicrm/v3/open` - a substitution for `civicrm/extern/open.php` to track when recipients open mailings. 4. `civicrm/v3/authorizeIPN` - a substitution for `civicrm/extern/authorizeIPN.php` (for testing Authorize.net as per [docs](https://docs.civicrm.org/sysadmin/en/latest/setup/payment-processors/authorize-net/#shell-script-testing-method))