api/v3/examples/AddressDelete.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function address_delete_example(){
   7 $params = array(
   8   'contact_id' => 8,
   9   'location_type_id' => 11,
  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   'version' => 3,
  18 );
  19
  20   $result = civicrm_api( 'address','delete',$params );
  21
  22   return $result;
  23 }
  24
  25 /*
  26  * Function returns array of result expected from previous function
  27  */
  28 function address_delete_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'values' => true,
  35 );
  36
  37   return $expectedResult  ;
  38 }
  39
  40
  41 /*
  42 * This example has been generated from the API test suite. The test that created it is called
  43 *
  44 * testDeleteAddress and can be found in
  45 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/AddressTest.php
  46 *
  47 * You can see the outcome of the API tests at
  48 * http://tests.dev.civicrm.org/trunk/results-api_v3
  49 *
  50 * To Learn about the API read
  51 * http://book.civicrm.org/developer/current/techniques/api/
  52 *
  53 * and review the wiki at
  54 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  55 *
  56 * Read more about testing here
  57 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  58 *
  59 * API Standards documentation:
  60 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  61 */