api/v3/examples/ActivityGet.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function activity_get_example(){
   7 $params = array(
   8   'contact_id' => 17,
   9   'activity_type_id' => '44',
  10   'version' => 3,
  11   'sequential' => 1,
  12   'return.custom_1' => 1,
  13 );
  14
  15   $result = civicrm_api( 'activity','get',$params );
  16
  17   return $result;
  18 }
  19
  20 /*
  21  * Function returns array of result expected from previous function
  22  */
  23 function activity_get_expectedresult(){
  24
  25   $expectedResult = array(
  26   'is_error' => 0,
  27   'version' => 3,
  28   'count' => 1,
  29   'id' => 1,
  30   'values' => array(
  31       '0' => array(
  32           'source_contact_id' => '17',
  33           'id' => '1',
  34           'activity_type_id' => '44',
  35           'subject' => 'test activity type id',
  36           'location' => 'Pensulvania',
  37           'activity_date_time' => '2011-06-02 14:36:13',
  38           'details' => 'a test activity',
  39           'status_id' => '2',
  40           'activity_name' => 'Test activity type',
  41           'status' => 'Completed',
  42           'custom_1' => 'custom string',
  43           'custom_1_1' => 'custom string',
  44         ),
  45     ),
  46 );
  47
  48   return $expectedResult  ;
  49 }
  50
  51
  52 /*
  53 * This example has been generated from the API test suite. The test that created it is called
  54 *
  55 * testActivityGetContact_idCustom and can be found in
  56 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ActivityTest.php
  57 *
  58 * You can see the outcome of the API tests at
  59 * http://tests.dev.civicrm.org/trunk/results-api_v3
  60 *
  61 * To Learn about the API read
  62 * http://book.civicrm.org/developer/current/techniques/api/
  63 *
  64 * and review the wiki at
  65 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  66 *
  67 * Read more about testing here
  68 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  69 *
  70 * API Standards documentation:
  71 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  72 */