api/v3/examples/Note/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using note get API
   4  * *
   5  */
   6 function note_get_example(){
   7 $params = array(
   8   'entity_table' => 'civicrm_contact',
   9   'entity_id' => 1,
  10 );
  11
  12 try{
  13   $result = civicrm_api3('note', '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 note_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           'entity_table' => 'civicrm_contact',
  40           'entity_id' => '1',
  41           'note' => 'hello I am testing Note',
  42           'contact_id' => '1',
  43           'modified_date' => '2012-11-14 16:02:35',
  44           'subject' => 'Test Note',
  45           'privacy' => 0,
  46         ),
  47     ),
  48 );
  49
  50   return $expectedResult;
  51 }
  52
  53
  54 /*
  55 * This example has been generated from the API test suite. The test that created it is called
  56 *
  57 * testGet and can be found in
  58 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/NoteTest.php
  59 *
  60 * You can see the outcome of the API tests at
  61 * https://test.civicrm.org/job/CiviCRM-master-git/
  62 *
  63 * To Learn about the API read
  64 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  65 *
  66 * Browse the api on your own site with the api explorer
  67 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  68 *
  69 * Read more about testing here
  70 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  71 *
  72 * API Standards documentation:
  73 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  74 */