3 * Test Generated example of using contact getvalue API
4 * This demonstrates use of the 'format.single_value' param.
5 /* This param causes only a single value of the only entity to be returned as an string.
6 /* it will be ignored if there is not exactly 1 result *
8 function contact_getvalue_example(){
11 'return' => 'display_name',
15 $result = civicrm_api3('contact', 'getvalue', $params);
17 catch (CiviCRM_API3_Exception
$e) {
19 $errorMessage = $e->getMessage();
20 $errorCode = $e->getErrorCode();
21 $errorData = $e->getExtraParams();
22 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
29 * Function returns array of result expected from previous function
31 function contact_getvalue_expectedresult(){
33 $expectedResult = 'Test Contact';
35 return $expectedResult;
40 * This example has been generated from the API test suite. The test that created it is called
42 * testContactGetFormatSingleValue and can be found in
43 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
45 * You can see the outcome of the API tests at
46 * https://test.civicrm.org/job/CiviCRM-master-git/
48 * To Learn about the API read
49 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
51 * Browse the api on your own site with the api explorer
52 * http://MYSITE.ORG/path/to/civicrm/api/explorer
54 * Read more about testing here
55 * http://wiki.civicrm.org/confluence/display/CRM/Testing
57 * API Standards documentation:
58 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards