api/v3/examples/Activity/ContactRefCustomFieldGet.php

   1 <?php
   2 /**
   3  * Test Generated example of using activity get API
   4  * Get with Contact Ref Custom Field *
   5  */
   6 function activity_get_example(){
   7 $params = array(
   8   'return.custom_2' => 1,
   9   'id' => 1,
  10 );
  11
  12 try{
  13   $result = civicrm_api3('activity', 'get', $params);
  14 }
  15 catch (CiviCRM_API3_Exception $e) {
  16   // handle error here
  17   $errorMessage = $e->getMessage();
  18   $errorCode = $e->getErrorCode();
  19   $errorData = $e->getExtraParams();
  20   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  21 }
  22
  23 return $result;
  24 }
  25
  26 /**
  27  * Function returns array of result expected from previous function
  28  */
  29 function activity_get_expectedresult(){
  30
  31   $expectedResult = array(
  32   'is_error' => 0,
  33   'version' => 3,
  34   'count' => 1,
  35   'id' => 1,
  36   'values' => array(
  37       '1' => array(
  38           'id' => '1',
  39           'activity_type_id' => '49',
  40           'subject' => 'test activity type id',
  41           'activity_date_time' => '2011-06-02 14:36:13',
  42           'duration' => '120',
  43           'location' => 'Pensulvania',
  44           'details' => 'a test activity',
  45           'status_id' => '2',
  46           'priority_id' => '1',
  47           'is_test' => 0,
  48           'is_auto' => 0,
  49           'is_current_revision' => '1',
  50           'is_deleted' => 0,
  51           'source_contact_id' => '1',
  52           'custom_1' => 'defaultValue',
  53           'custom_1_1' => 'defaultValue',
  54           'custom_2' => 'Anderson, Anthony',
  55           'custom_2_1' => 'Anderson, Anthony',
  56           'custom_2_1_id' => '1',
  57           'custom_2_id' => '1',
  58         ),
  59     ),
  60 );
  61
  62   return $expectedResult;
  63 }
  64
  65
  66 /*
  67 * This example has been generated from the API test suite. The test that created it is called
  68 *
  69 * testActivityCreateCustomContactRefField and can be found in
  70 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityTest.php
  71 *
  72 * You can see the outcome of the API tests at
  73 * https://test.civicrm.org/job/CiviCRM-master-git/
  74 *
  75 * To Learn about the API read
  76 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  77 *
  78 * Browse the api on your own site with the api explorer
  79 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  80 *
  81 * Read more about testing here
  82 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  83 *
  84 * API Standards documentation:
  85 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  86 */