3 * Test Generated example of using contact get API.
5 * This demonstrates use of the 'format.is_success' param.
6 This param causes only the success or otherwise of the function to be returned as BOOLEAN
11 function contact_get_example() {
14 'format.is_success' => 1,
18 $result = civicrm_api3('contact', 'get', $params);
20 catch (CiviCRM_API3_Exception
$e) {
22 $errorMessage = $e->getMessage();
23 $errorCode = $e->getErrorCode();
24 $errorData = $e->getExtraParams();
26 'error' => $errorMessage,
27 'error_code' => $errorCode,
28 'error_data' => $errorData,
36 * Function returns array of result expected from previous function.
41 function contact_get_expectedresult() {
45 return $expectedResult;
49 * This example has been generated from the API test suite.
50 * The test that created it is called
51 * testContactGetFormatIsSuccessTrue
53 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
55 * You can see the outcome of the API tests at
56 * https://test.civicrm.org/job/CiviCRM-master-git/
58 * To Learn about the API read
59 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
61 * Browse the api on your own site with the api explorer
62 * http://MYSITE.ORG/path/to/civicrm/api
64 * Read more about testing here
65 * http://wiki.civicrm.org/confluence/display/CRM/Testing
67 * API Standards documentation:
68 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards