3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM survey/petition records.
31 * @note Campaign component must be enabled.
32 * @note There is no "petition" api.
33 * Surveys and petitions are the same basic object and this api is used for both.
35 * @package CiviCRM_APIv3
39 * Create or update a survey.
41 * @param array $params
42 * Array per getfields metadata.
47 function civicrm_api3_survey_create($params) {
48 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Survey');
52 * Adjust Metadata for Create action.
54 * The metadata is used for setting defaults, documentation & validation.
56 * @param array $params
57 * Array of parameters determined by getfields.
59 function _civicrm_api3_survey_create_spec(&$params) {
60 $params['title']['api.required'] = 1;
64 * Returns array of surveys matching a set of one or more group properties.
66 * @param array $params
67 * Array of properties. If empty, all records will be returned.
70 * API result Array of matching surveys
72 function civicrm_api3_survey_get($params) {
73 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, TRUE, 'Survey');
77 * Delete an existing survey.
79 * This method is used to delete any existing survey given its id.
81 * @param array $params
87 function civicrm_api3_survey_delete($params) {
88 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
92 * Set default getlist parameters.
94 * @see _civicrm_api3_generic_getlist_defaults
96 * @param array $request
100 function _civicrm_api3_survey_getlist_defaults(&$request) {
102 'description_field' => [