fa74cbafd61689f04894f992ca15830004c87d05
3 * Test Generated example demonstrating the Contact.get API.
5 * This demonstrates use of the 'format.id_only' param.
6 * This param causes the id of the only entity to be returned as an integer.
7 * It will be ignored if there is not exactly 1 result
12 function contact_get_example() {
15 'format.only_id' => 1,
19 $result = civicrm_api3('Contact', 'get', $params);
21 catch (CiviCRM_API3_Exception
$e) {
23 $errorMessage = $e->getMessage();
24 $errorCode = $e->getErrorCode();
25 $errorData = $e->getExtraParams();
27 'error' => $errorMessage,
28 'error_code' => $errorCode,
29 'error_data' => $errorData,
37 * Function returns array of result expected from previous function.
42 function contact_get_expectedresult() {
46 return $expectedResult;
50 * This example has been generated from the API test suite.
51 * The test that created it is called "testContactGetFormatIDOnly"
52 * and can be found at:
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