4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 group functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Event
34 * @copyright CiviCRM LLC (c) 2004-2014
38 * create/update participant_status
40 * This API is used to create new participant_status or update any of the existing
41 * In case of updating existing participant_status, id of that particular participant_status must
42 * be in $params array.
44 * @param array $params Associative array of property
45 * name/value pairs to insert in new 'participant_status'
47 * @return array participant_status array
48 * {@getfields ParticipantStatusType_create}
49 * @example ParticipantStatusTypeCreate.php
52 function civicrm_api3_participant_status_type_create($params) {
53 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
57 * Returns array of participant_statuses matching a set of one or more group properties
59 * @param array $params Array of one or more valid
60 * property_name=>value pairs. If $params is set
61 * as null, all participant_statuses will be returned
63 * @return array Array of matching participant_statuses
64 * {@getfields ParticipantStatusType_get}
65 * @example ParticipantStatusTypeGet.php
68 function civicrm_api3_participant_status_type_get($params) {
69 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
73 * delete an existing participant_status
75 * This method is used to delete any existing participant_status. id of the group
76 * to be deleted is required field in $params array
78 * @param array $params (reference) array containing id of the group
81 * @return array api result array
82 * {@getfields ParticipantStatusType_delete}
83 * @example ParticipantStatusTypeDelete.php
86 function civicrm_api3_participant_status_type_delete($params) {
87 if (CRM_Event_BAO_ParticipantStatusType
::deleteParticipantStatusType($params['id'])) {
88 return civicrm_api3_create_success(TRUE);
91 return civicrm_api3_create_error(TRUE);