diff --git a/docs/api/custom-data.md b/docs/api/custom-data.md index 3857232de2a9124fe0f443288e01894c5884dd13..c5ec0072f00f03d43510f75ab02c3d3230991e6d 100644 --- a/docs/api/custom-data.md +++ b/docs/api/custom-data.md @@ -15,11 +15,13 @@ $params['return.custom_N'] = 1; ``` *or (depending on which API entity you are querying)* + ```php $params['return'] = 'custom_N'; ``` *or* + ```php $params['return'] = 'custom_N,custom_O,custom_P'; ``` @@ -31,12 +33,14 @@ which vary for each API entity and function. ## Custom Value get -If developers want to get all custom data related to a perticular entity. The best method is to do a `CustomValue.get` API Call. +If developers want to get all custom data related to a particular entity. The best method is to do a `CustomValue.get` API Call. ```php $result = civicrm_api3('CustomValue', 'get', array('entity_id' => 1)); ``` + A sample output would be like the following + ```php { "is_error":0, @@ -57,7 +61,7 @@ A sample output would be like the following For entities other than the Contact Entity you can use an alternate notation to the `custom_n` to specify the custom fields you wish to return. You can use `custom_group_name:custom_field_name`. Read carefully the documentation and parameters in `CustomValue.php` for more alternatives and details. -!!!note -When retrieving custom data for contact entity, it will only return one value in the case of a multiple custom group set whereas for other entites e.g. Address, or using the CustomValue. get API you will get all custom data records that relate to the relevant entity +!!! note + When retrieving custom data for contact entity, it will only return one value in the case of a multiple custom group set whereas for other entities (e.g. Address, or using the `CustomValue.get` API) you will get all custom data records that relate to the relevant entity -The CustomValue Entity implicitly deteremines what the `entity_table` variable should be when it is not supplied. If developers are finding that the implicity is not working out exactly then developers should spcifiy the `entity_table` key. +The CustomValue Entity implicitly determines what the `entity_table` variable should be when it is not supplied. If you find that the implicitly is not working out exactly, then specify the `entity_table` key. diff --git a/docs/api/options.md b/docs/api/options.md index 1b6ad320f7488487ed80532ef1dee3d88f9f2b4b..9a51087087c858e8726665958be89f11d2a0f4d0 100644 --- a/docs/api/options.md +++ b/docs/api/options.md @@ -1,6 +1,6 @@ # API Options -There are many API Options accepted by the CiviCRM API. These options allow the developer to add in more paramaters to the resulting Query that is run against the databasae. E.g. Limit, Sort. You can explore these options using the the [API Explorer](/api#api-explorer) and the [API Examples](/api/examples) However, some parameters are particularly dynamic or generic; these may not be explained well by the auto-generated documentation. The format for passing options as parameters using the REST interface is explained at [REST interface](/api/interfaces#rest). +There are many API Options accepted by the CiviCRM API. These options allow the developer to add in more parameters to the resulting Query that is run against the database. E.g. Limit, Sort. You can explore these options using the the [API Explorer](/api/index.md#api-explorer) and the [API Examples](/api/examples.md) However, some parameters are particularly dynamic or generic; these may not be explained well by the auto-generated documentation. The format for passing options as parameters using the REST interface is explained at [REST interface](/api/interfaces.md#rest). ## sequential