3 * Test Generated example of using report_template getrows API
4 * Retrieve rows from a report template (optionally providing the instance_id) *
6 function report_template_getrows_example(){
8 'report_id' => 'contact/summary',
12 $result = civicrm_api3('report_template', 'getrows', $params);
14 catch (CiviCRM_API3_Exception
$e) {
16 $errorMessage = $e->getMessage();
17 $errorCode = $e->getErrorCode();
18 $errorData = $e->getExtraParams();
19 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
26 * Function returns array of result expected from previous function
28 function report_template_getrows_expectedresult(){
30 $expectedResult = array(
36 'civicrm_contact_sort_name' => 'Default Organization',
37 'civicrm_contact_id' => '1',
38 'civicrm_address_street_address' => '',
39 'civicrm_address_city' => '',
40 'civicrm_country_name' => '',
43 'civicrm_contact_sort_name' => 'Second Domain',
44 'civicrm_contact_id' => '2',
45 'civicrm_address_street_address' => '15 Main St',
46 'civicrm_address_city' => 'Collinsville',
47 'civicrm_country_name' => 'United States',
52 return $expectedResult;
57 * This example has been generated from the API test suite. The test that created it is called
59 * testReportTemplateGetRowsContactSummary and can be found in
60 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ReportTemplateTest.php
62 * You can see the outcome of the API tests at
63 * http://tests.dev.civicrm.org/trunk/results-api_v3
65 * To Learn about the API read
66 * http://book.civicrm.org/developer/current/techniques/api/
68 * and review the wiki at
69 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
71 * Read more about testing here
72 * http://wiki.civicrm.org/confluence/display/CRM/Testing
74 * API Standards documentation:
75 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards