api/v3/examples/Address/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using address get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function address_get_example() {
   9   $params = array(
  10     'contact_id' => 17,
  11     'street_name' => 'Ambachtstraat',
  12   );
  13
  14   try{
  15     $result = civicrm_api3('address', '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(
  23       'error' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     );
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function address_get_expectedresult() {
  39
  40   $expectedResult = array(
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 1,
  45     'values' => array(
  46       '1' => array(
  47         'id' => '1',
  48         'contact_id' => '17',
  49         'location_type_id' => '15',
  50         'is_primary' => '1',
  51         'is_billing' => 0,
  52         'street_address' => 'Ambachtstraat 23',
  53         'street_number' => '23',
  54         'street_name' => 'Ambachtstraat',
  55         'city' => 'Brummen',
  56         'postal_code' => '6971 BN',
  57         'country_id' => '1152',
  58         'manual_geo_code' => 0,
  59       ),
  60     ),
  61   );
  62
  63   return $expectedResult;
  64 }
  65
  66 /**
  67 * This example has been generated from the API test suite.
  68 * The test that created it is called
  69 * testGetAddress
  70 * and can be found in
  71 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php
  72 *
  73 * You can see the outcome of the API tests at
  74 * https://test.civicrm.org/job/CiviCRM-master-git/
  75 *
  76 * To Learn about the API read
  77 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  78 *
  79 * Browse the api on your own site with the api explorer
  80 * http://MYSITE.ORG/path/to/civicrm/api
  81 *
  82 * Read more about testing here
  83 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  84 *
  85 * API Standards documentation:
  86 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  87 */