3 * Test Generated example of using contact get API
4 * This demonstrates use of the 'format.is_success' param.
5 This param causes only the success or otherwise of the function to be returned as BOOLEAN *
7 function contact_get_example(){
10 'format.is_success' => 1,
14 $result = civicrm_api3('contact', 'get', $params);
16 catch (CiviCRM_API3_Exception
$e) {
18 $errorMessage = $e->getMessage();
19 $errorCode = $e->getErrorCode();
20 $errorData = $e->getExtraParams();
21 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
28 * Function returns array of result expected from previous function
30 function contact_get_expectedresult(){
34 return $expectedResult;
39 * This example has been generated from the API test suite. The test that created it is called
41 * testContactGetFormatIsSuccessTrue and can be found in
42 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
44 * You can see the outcome of the API tests at
45 * http://tests.dev.civicrm.org/trunk/results-api_v3
47 * To Learn about the API read
48 * http://book.civicrm.org/developer/current/techniques/api/
50 * and review the wiki at
51 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
53 * Read more about testing here
54 * http://wiki.civicrm.org/confluence/display/CRM/Testing
56 * API Standards documentation:
57 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards