4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC. All rights reserved. |
7 | This work is published under the GNU AGPLv3 license with some |
8 | permitted exceptions and without any warranty. For full license |
9 | and copyright information, see https://civicrm.org/licensing |
10 +--------------------------------------------------------------------+
14 * This api exposes CiviCRM MappingField records.
16 * @package CiviCRM_APIv3
20 * Add a Mapping Field.
22 * @param array $params
26 function civicrm_api3_mapping_field_create($params) {
27 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'MappingField');
31 * Adjust Metadata for Create action.
33 * The metadata is used for setting defaults, documentation & validation.
35 * @param array $params
36 * Array of parameters determined by getfields.
38 function _civicrm_api3_mapping_field_create_spec(&$params) {
39 $params['mapping_id']['api.required'] = 1;
43 * Deletes an existing Mapping Field.
45 * @param array $params
50 function civicrm_api3_mapping_field_delete($params) {
51 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
55 * Retrieve one or more Mapping Fields.
57 * @param array $params
58 * An associative array of name/value pairs.
61 * details of found Mapping Fields
63 function civicrm_api3_mapping_field_get($params) {
64 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);