3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 * File for the CiviCRM APIv3 group contact functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Group
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $
41 * This API will give list of the groups for particular contact
42 * Particualr status can be sent in params array
43 * If no status mentioned in params, by default 'added' will be used
44 * to fetch the records
46 * @param array $params
47 * Name value pair of contact information.
48 * {@getfields GroupOrganization_get}
49 * @example GroupOrganizationGet.php
52 * list of groups, given contact subsribed to
54 function civicrm_api3_group_organization_get($params) {
55 return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
59 * @example GroupOrganizationCreate.php
60 * {@getfields GroupOrganization_create}
62 * @param array $params
68 function civicrm_api3_group_organization_create($params) {
70 $groupOrgBAO = CRM_Contact_BAO_GroupOrganization
::add($params);
72 if (is_null($groupOrgBAO)) {
73 return civicrm_api3_create_error("group organization not created");
76 _civicrm_api3_object_to_array($groupOrgBAO, $values);
77 return civicrm_api3_create_success($values, $params, 'group_organization', 'get', $groupOrgBAO);
81 * Adjust Metadata for Create action
83 * The metadata is used for setting defaults, documentation & validation
84 * @param array $params
85 * Array or parameters determined by getfields.
87 function _civicrm_api3_group_organization_create_spec(&$params) {
88 $params['organization_id']['api.required'] = 1;
89 $params['group_id']['api.required'] = 1;
93 * Deletes an existing Group Organization
95 * This API is used for deleting a Group Organization
97 * @param array $params
98 * With 'id' = ID of the Group Organization to be deleted.
102 * {@getfields GroupOrganization_delete}
103 * @example GroupOrganizationDelete.php
106 function civicrm_api3_group_organization_delete($params) {
108 $result = CRM_Contact_BAO_GroupOrganization
::deleteGroupOrganization($params['id']);
109 return $result ?
civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization');