3 * Test Generated example of using contact get API
4 * /*this demonstrates setting a custom field through the API *
6 function contact_get_example(){
8 'return.custom_1' => 1,
13 $result = civicrm_api3('contact', 'get', $params);
15 catch (CiviCRM_API3_Exception
$e) {
17 $errorMessage = $e->getMessage();
18 $errorCode = $e->getErrorCode();
19 $errorData = $e->getExtraParams();
20 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
27 * Function returns array of result expected from previous function
29 function contact_get_expectedresult(){
31 $expectedResult = array(
39 'civicrm_value_testgetwithcu_1_id' => '1',
40 'custom_1' => 'custom string',
46 return $expectedResult;
51 * This example has been generated from the API test suite. The test that created it is called
53 * testGetWithCustom and can be found in
54 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
56 * You can see the outcome of the API tests at
57 * https://test.civicrm.org/job/CiviCRM-master-git/
59 * To Learn about the API read
60 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
62 * Browse the api on your own site with the api explorer
63 * http://MYSITE.ORG/path/to/civicrm/api/explorer
65 * Read more about testing here
66 * http://wiki.civicrm.org/confluence/display/CRM/Testing
68 * API Standards documentation:
69 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards