3 * Test Generated example of using contact getactions API
4 * Getting the available actions for an entity. *
6 function contact_getactions_example(){
10 $result = civicrm_api3('contact', 'getactions', $params);
12 catch (CiviCRM_API3_Exception
$e) {
14 $errorMessage = $e->getMessage();
15 $errorCode = $e->getErrorCode();
16 $errorData = $e->getExtraParams();
17 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
24 * Function returns array of result expected from previous function
26 function contact_getactions_expectedresult(){
28 $expectedResult = array(
51 'deprecated' => array(
52 'getquick' => 'The "getquick" action is deprecated in favor of "getlist".',
53 'update' => 'The "update" action is deprecated. Use "create" with an id instead.',
57 return $expectedResult;
62 * This example has been generated from the API test suite. The test that created it is called
64 * testGetActions and can be found in
65 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
67 * You can see the outcome of the API tests at
68 * https://test.civicrm.org/job/CiviCRM-master-git/
70 * To Learn about the API read
71 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
73 * Browse the api on your own site with the api explorer
74 * http://MYSITE.ORG/path/to/civicrm/api/explorer
76 * Read more about testing here
77 * http://wiki.civicrm.org/confluence/display/CRM/Testing
79 * API Standards documentation:
80 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards