3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
13 * This api exposes CiviCRM states/provinces
15 * @package CiviCRM_APIv3
19 * Add a state/province.
21 * @param array $params
22 * Array per getfields metadata.
26 * @throws \API_Exception
28 function civicrm_api3_state_province_create($params) {
29 return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__
), $params, 'StateProvince');
33 * Adjust Metadata for Create action.
35 * The metadata is used for setting defaults, documentation & validation.
37 * @param array $params
38 * Array of parameters determined by getfields.
40 function _civicrm_api3_state_province_create_spec(&$params) {
41 $params['name']['api.required'] = 1;
42 $params['country_id']['api.required'] = 1;
43 $params['abbreviation']['api.required'] = 1;
47 * Deletes an existing state/province.
49 * @param array $params
53 function civicrm_api3_state_province_delete($params) {
54 return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__
), $params);
58 * Retrieve one or more states/provinces.
60 * @param array $params
61 * Array per getfields metadata.
66 function civicrm_api3_state_province_get($params) {
67 return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__
), $params);