api/v3/examples/Im/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using im get API
   4  * *
   5  */
   6 function im_get_example(){
   7 $params = array(
   8   'contact_id' => 1,
   9   'name' => 'My Yahoo IM Handle',
  10   'location_type_id' => 1,
  11   'provider_id' => 1,
  12 );
  13
  14 try{
  15   $result = civicrm_api3('im', 'get', $params);
  16 }
  17 catch (CiviCRM_API3_Exception $e) {
  18   // handle error here
  19   $errorMessage = $e->getMessage();
  20   $errorCode = $e->getErrorCode();
  21   $errorData = $e->getExtraParams();
  22   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  23 }
  24
  25 return $result;
  26 }
  27
  28 /**
  29  * Function returns array of result expected from previous function
  30  */
  31 function im_get_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 1,
  38   'values' => array(
  39       '1' => array(
  40           'id' => '1',
  41           'contact_id' => '1',
  42           'location_type_id' => '1',
  43           'name' => 'My Yahoo IM Handle',
  44           'provider_id' => '1',
  45           'is_primary' => 0,
  46           'is_billing' => 0,
  47         ),
  48     ),
  49 );
  50
  51   return $expectedResult;
  52 }
  53
  54
  55 /*
  56 * This example has been generated from the API test suite. The test that created it is called
  57 *
  58 * testGetIm and can be found in
  59 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ImTest.php
  60 *
  61 * You can see the outcome of the API tests at
  62 * https://test.civicrm.org/job/CiviCRM-master-git/
  63 *
  64 * To Learn about the API read
  65 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  66 *
  67 * Browse the api on your own site with the api explorer
  68 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  69 *
  70 * Read more about testing here
  71 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  72 *
  73 * API Standards documentation:
  74 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  75 */