Merge pull request #583 from yashodha/CRM-12463
[civicrm-core.git] / api / v3 / examples / BatchGet.php
CommitLineData
6a488035
TO
1<?php
2
3/*
4
5 */
6function batch_get_example(){
7$params = array(
8 'id' => 1,
9 'version' => 3,
10);
11
12 $result = civicrm_api( 'batch','get',$params );
13
14 return $result;
15}
16
17/*
18 * Function returns array of result expected from previous function
19 */
20function batch_get_expectedresult(){
21
22 $expectedResult = array(
23 'is_error' => 0,
24 'version' => 3,
25 'count' => 1,
26 'id' => 1,
27 'values' => array(
28 '1' => array(
29 'id' => '1',
30 'name' => 'Batch_985446',
31 'title' => 'Batch_985446',
32 'status_id' => '1',
33 ),
34 ),
35);
36
37 return $expectedResult ;
38}
39
40
41/*
42* This example has been generated from the API test suite. The test that created it is called
43*
44* testGet and can be found in
45* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/BatchTest.php
46*
47* You can see the outcome of the API tests at
48* http://tests.dev.civicrm.org/trunk/results-api_v3
49*
50* To Learn about the API read
51* http://book.civicrm.org/developer/current/techniques/api/
52*
53* and review the wiki at
54* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
55*
56* Read more about testing here
57* http://wiki.civicrm.org/confluence/display/CRM/Testing
58*
59* API Standards documentation:
60* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
61*/