3 --------------------------------------------------------------------
4 | CiviCRM version 4.7 |
5 --------------------------------------------------------------------
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 EntityBatch records.
31 * Use this api to add/remove entities from a batch.
32 * To create/update/delete the batches themselves, use the Batch api.
34 * @package CiviCRM_APIv3
40 * @param array $params
44 function civicrm_api3_entity_batch_get($params) {
45 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
49 * Adjust Metadata for Create action.
51 * The metadata is used for setting defaults, documentation & validation.
53 * @param array $params
54 * Array of parameters determined by getfields.
56 function _civicrm_api3_entity_batch_create_spec(&$params) {
57 $params['entity_id']['api.required'] = 1;
58 $params['batch_id']['api.required'] = 1;
62 * Create an entity batch.
64 * @param array $params
68 function civicrm_api3_entity_batch_create($params) {
69 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
73 * Mark entity batch as removed.
75 * @param array $params
79 function civicrm_api3_entity_batch_delete($params) {
80 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);