3 * Test Generated example demonstrating the Tag.getlist API.
5 * Demonstrates use of api.getlist for autocomplete and quicksearch applications.
10 function tag_getlist_example() {
12 'input' => 'New Tag3',
19 $result = civicrm_api3('Tag', 'getlist', $params);
21 catch (CiviCRM_API3_Exception
$e) {
23 $errorMessage = $e->getMessage();
24 $errorCode = $e->getErrorCode();
25 $errorData = $e->getExtraParams();
28 'error_message' => $errorMessage,
29 'error_code' => $errorCode,
30 'error_data' => $errorData,
38 * Function returns array of result expected from previous function.
43 function tag_getlist_expectedresult() {
45 $expectedResult = array(
53 'label' => 'New Tag3',
54 'description' => array(
55 '0' => 'This is description for Our New Tag ',
58 'used_for' => 'civicrm_contact',
66 return $expectedResult;
70 * This example has been generated from the API test suite.
71 * The test that created it is called "testTagGetList"
72 * and can be found at:
73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/TagTest.php
75 * You can see the outcome of the API tests at
76 * https://test.civicrm.org/job/CiviCRM-master-git/
78 * To Learn about the API read
79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
81 * Browse the api on your own site with the api explorer
82 * http://MYSITE.ORG/path/to/civicrm/api
84 * Read more about testing here
85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
87 * API Standards documentation:
88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards