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(){
12 'return' => 'display_name',
15 $result = civicrm_api( 'contact','getvalue',$params );
21 * Function returns array of result expected from previous function
23 function contact_getvalue_expectedresult(){
25 $expectedResult = 'Test Contact';
27 return $expectedResult ;
32 * This example has been generated from the API test suite. The test that created it is called
34 * testContactGetFormatSingleValue and can be found in
35 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
37 * You can see the outcome of the API tests at
38 * http://tests.dev.civicrm.org/trunk/results-api_v3
40 * To Learn about the API read
41 * http://book.civicrm.org/developer/current/techniques/api/
43 * and review the wiki at
44 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
46 * Read more about testing here
47 * http://wiki.civicrm.org/confluence/display/CRM/Testing
49 * API Standards documentation:
50 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards