3 * Test Generated example of using contact getoptions API.
5 * Demonstrates retrieving options for a custom field
10 function contact_getoptions_example() {
12 'field' => 'custom_1',
16 $result = civicrm_api3('contact', 'getoptions', $params);
18 catch (CiviCRM_API3_Exception
$e) {
20 $errorMessage = $e->getMessage();
21 $errorCode = $e->getErrorCode();
22 $errorData = $e->getExtraParams();
24 'error' => $errorMessage,
25 'error_code' => $errorCode,
26 'error_data' => $errorData,
34 * Function returns array of result expected from previous function.
39 function contact_getoptions_expectedresult() {
41 $expectedResult = array(
51 return $expectedResult;
55 * This example has been generated from the API test suite.
56 * The test that created it is called
57 * testCustomFieldCreateWithOptionValues
59 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
61 * You can see the outcome of the API tests at
62 * https://test.civicrm.org/job/CiviCRM-master-git/
64 * To Learn about the API read
65 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
67 * Browse the api on your own site with the api explorer
68 * http://MYSITE.ORG/path/to/civicrm/api
70 * Read more about testing here
71 * http://wiki.civicrm.org/confluence/display/CRM/Testing
73 * API Standards documentation:
74 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards