3 * Test Generated example of using contact get API
4 * This demonstrates use of the 'format.id_only' param.
5 /* This param causes the id of the only entity to be returned as an integer.
6 /* it will be ignored if there is not exactly 1 result *
8 function contact_get_example(){
11 'format.only_id' => 1,
15 $result = civicrm_api3('contact', 'get', $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_get_expectedresult(){
35 return $expectedResult;
40 * This example has been generated from the API test suite. The test that created it is called
42 * testContactGetFormatID_only and can be found in
43 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
45 * You can see the outcome of the API tests at
46 * http://tests.dev.civicrm.org/trunk/results-api_v3
48 * To Learn about the API read
49 * http://book.civicrm.org/developer/current/techniques/api/
51 * and review the wiki at
52 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
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