587b621c2f6959175509fd6584bf9af96f016d7d
3 * Test Generated example of using contact getvalue API.
5 * This demonstrates use of the 'format.single_value' param.
6 * This param causes only a single value of the only entity to be returned as an string.
7 * It will be ignored if there is not exactly 1 result
12 function contact_getvalue_example() {
15 'return' => 'display_name',
19 $result = civicrm_api3('contact', 'getvalue', $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_getvalue_expectedresult() {
44 $expectedResult = 'Test Contact';
46 return $expectedResult;
50 * This example has been generated from the API test suite.
51 * The test that created it is called
52 * testContactGetFormatSingleValue
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
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