api/v3/examples/Address/Create.php

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