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 * This api exposes the relationships between organizations and CiviCRM groups.
31 * @package CiviCRM_APIv3
32 * @subpackage API_Group
38 * Get group organization record/s.
40 * @param array $params
41 * Name value pair of contact information.
44 * list of groups, given contact subscribed to
46 function civicrm_api3_group_organization_get($params) {
47 return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
51 * Create group organization record.
53 * @param array $params
58 function civicrm_api3_group_organization_create($params) {
60 $groupOrgBAO = CRM_Contact_BAO_GroupOrganization
::add($params);
62 if (is_null($groupOrgBAO)) {
63 return civicrm_api3_create_error("group organization not created");
66 _civicrm_api3_object_to_array($groupOrgBAO, $values);
67 return civicrm_api3_create_success($values, $params, 'group_organization', 'get', $groupOrgBAO);
71 * Adjust Metadata for Create action.
73 * The metadata is used for setting defaults, documentation & validation.
75 * @param array $params
76 * Array or parameters determined by getfields.
78 function _civicrm_api3_group_organization_create_spec(&$params) {
79 $params['organization_id']['api.required'] = 1;
80 $params['group_id']['api.required'] = 1;
84 * Deletes an existing Group Organization.
86 * This API is used for deleting a Group Organization
88 * @param array $params
89 * With 'id' = ID of the Group Organization to be deleted.
94 function civicrm_api3_group_organization_delete($params) {
96 $result = CRM_Contact_BAO_GroupOrganization
::deleteGroupOrganization($params['id']);
97 return $result ?
civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization');