Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using contact get API | |
4 | * This demonstrates use of the 'format.id_only' param. | |
6a488035 | 5 | /* This param causes the id of the only entity to be returned as an integer. |
fb32de45 | 6 | /* it will be ignored if there is not exactly 1 result * |
6a488035 TO |
7 | */ |
8 | function contact_get_example(){ | |
edb0d67a | 9 | $params = array( |
6a488035 TO |
10 | 'id' => 17, |
11 | 'format.only_id' => 1, | |
12 | ); | |
13 | ||
fb32de45 | 14 | try{ |
15 | $result = civicrm_api3('contact', 'get', $params); | |
16 | } | |
17 | catch (CiviCRM_API3_Exception $e) { | |
18 | // handle error here | |
19 | $errorMessage = $e->getMessage(); | |
20 | $errorCode = $e->getErrorCode(); | |
21 | $errorData = $e->getExtraParams(); | |
22 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
23 | } | |
6a488035 | 24 | |
fb32de45 | 25 | return $result; |
6a488035 TO |
26 | } |
27 | ||
fb32de45 | 28 | /** |
6a488035 TO |
29 | * Function returns array of result expected from previous function |
30 | */ | |
31 | function contact_get_expectedresult(){ | |
32 | ||
33 | $expectedResult = 17; | |
34 | ||
fb32de45 | 35 | return $expectedResult; |
6a488035 TO |
36 | } |
37 | ||
38 | ||
39 | /* | |
40 | * This example has been generated from the API test suite. The test that created it is called | |
41 | * | |
42 | * testContactGetFormatID_only and can be found in | |
43 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php | |
44 | * | |
45 | * You can see the outcome of the API tests at | |
46 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
47 | * | |
48 | * To Learn about the API read | |
49 | * http://book.civicrm.org/developer/current/techniques/api/ | |
50 | * | |
51 | * and review the wiki at | |
52 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
53 | * | |
54 | * Read more about testing here | |
55 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
56 | * | |
57 | * API Standards documentation: | |
58 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
59 | */ |