api/v3/examples/GrantDelete.php

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