api/v3/examples/Contact/GetSingleContact.php

   1 <?php
   2 /**
   3  * Test Generated example of using contact getsingle API
   4  * This demonstrates use of the 'format.single_entity_array' param.
   5     /* This param causes the only contact to be returned as an array without the other levels.
   6     /* it will be ignored if there is not exactly 1 result *
   7  */
   8 function contact_getsingle_example(){
   9 $params = array(
  10   'id' => 17,
  11 );
  12
  13 try{
  14   $result = civicrm_api3('contact', 'getsingle', $params);
  15 }
  16 catch (CiviCRM_API3_Exception $e) {
  17   // handle error here
  18   $errorMessage = $e->getMessage();
  19   $errorCode = $e->getErrorCode();
  20   $errorData = $e->getExtraParams();
  21   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  22 }
  23
  24 return $result;
  25 }
  26
  27 /**
  28  * Function returns array of result expected from previous function
  29  */
  30 function contact_getsingle_expectedresult(){
  31
  32   $expectedResult = array(
  33   'contact_id' => '17',
  34   'contact_type' => 'Individual',
  35   'contact_sub_type' => '',
  36   'sort_name' => '',
  37   'display_name' => 'Test Contact',
  38   'do_not_email' => '',
  39   'do_not_phone' => '',
  40   'do_not_mail' => '',
  41   'do_not_sms' => '',
  42   'do_not_trade' => '',
  43   'is_opt_out' => 0,
  44   'legal_identifier' => '',
  45   'external_identifier' => '',
  46   'nick_name' => '',
  47   'legal_name' => '',
  48   'image_URL' => '',
  49   'preferred_communication_method' => '',
  50   'preferred_language' => '',
  51   'preferred_mail_format' => '',
  52   'first_name' => 'Test',
  53   'middle_name' => '',
  54   'last_name' => 'Contact',
  55   'prefix_id' => '',
  56   'suffix_id' => '',
  57   'job_title' => '',
  58   'gender_id' => '',
  59   'birth_date' => '',
  60   'is_deceased' => 0,
  61   'deceased_date' => '',
  62   'household_name' => '',
  63   'organization_name' => '',
  64   'sic_code' => '',
  65   'contact_is_deleted' => 0,
  66   'current_employer' => '',
  67   'address_id' => '',
  68   'street_address' => '',
  69   'supplemental_address_1' => '',
  70   'supplemental_address_2' => '',
  71   'city' => '',
  72   'postal_code_suffix' => '',
  73   'postal_code' => '',
  74   'geo_code_1' => '',
  75   'geo_code_2' => '',
  76   'state_province_id' => '',
  77   'country_id' => '',
  78   'phone_id' => '',
  79   'phone_type_id' => '',
  80   'phone' => '',
  81   'email_id' => '',
  82   'email' => '',
  83   'on_hold' => '',
  84   'im_id' => '',
  85   'provider_id' => '',
  86   'im' => '',
  87   'worldregion_id' => '',
  88   'world_region' => '',
  89   'individual_prefix' => '',
  90   'individual_suffix' => '',
  91   'gender' => '',
  92   'state_province_name' => '',
  93   'state_province' => '',
  94   'country' => '',
  95   'id' => '17',
  96 );
  97
  98   return $expectedResult;
  99 }
 100
 101
 102 /*
 103 * This example has been generated from the API test suite. The test that created it is called
 104 *
 105 * testContactGetSingle_entity_array and can be found in
 106 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContactTest.php
 107 *
 108 * You can see the outcome of the API tests at
 109 * http://tests.dev.civicrm.org/trunk/results-api_v3
 110 *
 111 * To Learn about the API read
 112 * http://book.civicrm.org/developer/current/techniques/api/
 113 *
 114 * and review the wiki at
 115 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
 116 *
 117 * Read more about testing here
 118 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 119 *
 120 * API Standards documentation:
 121 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
 122 */