[#28] Add API parameter documentation and fix typo in API sepc

This commit is contained in:
Jens Schuppe 2022-05-02 15:24:58 +02:00
parent 36a756e4dd
commit c81e10faaa
2 changed files with 3 additions and 2 deletions

View file

@ -102,10 +102,11 @@ The action accepts the following parameters:
| <nobr>`user_street`</nobr> | String | The street address of the contact | | | | <nobr>`user_street`</nobr> | String | The street address of the contact | | |
| <nobr>`user_postal_code`</nobr> | String | The postal code of the contact | | | | <nobr>`user_postal_code`</nobr> | String | The postal code of the contact | | |
| <nobr>`user_city`</nobr> | String | The city of the contact | | | | <nobr>`user_city`</nobr> | String | The city of the contact | | |
| <nobr>`user_country`</nobr> | String | The country of the contact | [ISO 3166-1 Alpha-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) | | | <nobr>`user_country`</nobr> | String | The country of the contact | A [ISO 3166-1 Alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) | |
| <nobr>`user_telephone`</nobr> | String | The telephone number of the contact | | | | <nobr>`user_telephone`</nobr> | String | The telephone number of the contact | | |
| <nobr>`user_company`</nobr> | String | The company of the contact | | | | <nobr>`user_company`</nobr> | String | The company of the contact | | |
| <nobr>`user_extrafield`</nobr> | String | Additional information of the contact | | | | <nobr>`user_extrafield`</nobr> | String | Additional information of the contact | | |
| <nobr>`user_language`</nobr> | String | The preferred language of the contact. | A [ISO-639-1 2-digit language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | |
| <nobr>`campaign_id`</nobr> | Integer | The CiviCRM ID of a campaign to assign the contribution | A valid CiviCRM Campaign ID. This overrides the campaign ID configured within the profile. | | | <nobr>`campaign_id`</nobr> | Integer | The CiviCRM ID of a campaign to assign the contribution | A valid CiviCRM Campaign ID. This overrides the campaign ID configured within the profile. | |
You may also refer to You may also refer to

View file

@ -224,7 +224,7 @@ function _civicrm_api3_twingle_donation_Submit_spec(&$params) {
'api.required' => 0, 'api.required' => 0,
'description' => E::ts('The company of the contact.'), 'description' => E::ts('The company of the contact.'),
); );
$params['user_extrafield'] = array( $params['user_language'] = array(
'name' => 'user_language', 'name' => 'user_language',
'title' => E::ts('Language'), 'title' => E::ts('Language'),
'type' => CRM_Utils_Type::T_STRING, 'type' => CRM_Utils_Type::T_STRING,