3 * Test Generated example of using contact get API.
5 * This demonstrates setting a custom field through the API.
10 function contact_get_example() {
12 'return' => 'custom_1',
17 $result = civicrm_api3('contact', 'get', $params);
19 catch (CiviCRM_API3_Exception
$e) {
21 $errorMessage = $e->getMessage();
22 $errorCode = $e->getErrorCode();
23 $errorData = $e->getExtraParams();
25 'error' => $errorMessage,
26 'error_code' => $errorCode,
27 'error_data' => $errorData,
35 * Function returns array of result expected from previous function.
40 function contact_get_expectedresult() {
42 $expectedResult = array(
50 'civicrm_value_testgetwithcu_1_id' => '1',
51 'custom_1' => 'custom string',
57 return $expectedResult;
61 * This example has been generated from the API test suite.
62 * The test that created it is called
63 * testGetWithCustomReturnSyntax
65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
67 * You can see the outcome of the API tests at
68 * https://test.civicrm.org/job/CiviCRM-master-git/
70 * To Learn about the API read
71 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
73 * Browse the api on your own site with the api explorer
74 * http://MYSITE.ORG/path/to/civicrm/api
76 * Read more about testing here
77 * http://wiki.civicrm.org/confluence/display/CRM/Testing
79 * API Standards documentation:
80 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards