From 4f53d6f2c1aa9a51485f61c6f0648fc2da570994 Mon Sep 17 00:00:00 2001
From: eileen <eileen@fuzion.co.nz>
Date: Thu, 16 May 2013 01:49:29 +1200
Subject: [PATCH] add  soft credit api examples

---
 api/v3/examples/ContributionSoftCreate.php | 69 ++++++++++++++++++++++
 api/v3/examples/ContributionSoftDelete.php | 48 +++++++++++++++
 api/v3/examples/ContributionSoftGet.php    | 63 ++++++++++++++++++++
 3 files changed, 180 insertions(+)
 create mode 100644 api/v3/examples/ContributionSoftCreate.php
 create mode 100644 api/v3/examples/ContributionSoftDelete.php
 create mode 100644 api/v3/examples/ContributionSoftGet.php

diff --git a/api/v3/examples/ContributionSoftCreate.php b/api/v3/examples/ContributionSoftCreate.php
new file mode 100644
index 0000000000..6290b9a3c9
--- /dev/null
+++ b/api/v3/examples/ContributionSoftCreate.php
@@ -0,0 +1,69 @@
+<?php
+
+/*
+ 
+ */
+function contribution_soft_create_example(){
+$params = array( 
+  'contribution_id' => 1,
+  'contact_id' => 2,
+  'amount' => '10',
+  'currency' => 'USD',
+  'version' => 3,
+);
+
+  $result = civicrm_api( 'contribution_soft','create',$params );
+
+  return $result;
+}
+
+/*
+ * Function returns array of result expected from previous function
+ */
+function contribution_soft_create_expectedresult(){
+
+  $expectedResult = array( 
+  'is_error' => 0,
+  'version' => 3,
+  'count' => 1,
+  'id' => 1,
+  'values' => array( 
+      '1' => array( 
+          'id' => '1',
+          'contribution_id' => '1',
+          'contact_id' => '2',
+          'amount' => '10',
+          'currency' => 'USD',
+          'pcp_id' => '',
+          'pcp_display_in_roll' => '',
+          'pcp_roll_nickname' => '',
+          'pcp_personal_note' => '',
+        ),
+    ),
+);
+
+  return $expectedResult  ;
+}
+
+
+/*
+* This example has been generated from the API test suite. The test that created it is called
+*
+* testCreateContributionSoft and can be found in
+* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionSoftTest.php
+*
+* You can see the outcome of the API tests at
+* http://tests.dev.civicrm.org/trunk/results-api_v3
+*
+* To Learn about the API read
+* http://book.civicrm.org/developer/current/techniques/api/
+*
+* and review the wiki at
+* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
\ No newline at end of file
diff --git a/api/v3/examples/ContributionSoftDelete.php b/api/v3/examples/ContributionSoftDelete.php
new file mode 100644
index 0000000000..959cf4d79d
--- /dev/null
+++ b/api/v3/examples/ContributionSoftDelete.php
@@ -0,0 +1,48 @@
+<?php
+
+/*
+ 
+ */
+function contribution_soft_delete_example(){
+$params = array( 
+  'id' => 1,
+  'version' => 3,
+);
+
+  $result = civicrm_api( 'contribution_soft','delete',$params );
+
+  return $result;
+}
+
+/*
+ * Function returns array of result expected from previous function
+ */
+function contribution_soft_delete_expectedresult(){
+
+  $expectedResult = '';
+
+  return $expectedResult  ;
+}
+
+
+/*
+* This example has been generated from the API test suite. The test that created it is called
+*
+* testDeleteContributionSoft and can be found in
+* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionSoftTest.php
+*
+* You can see the outcome of the API tests at
+* http://tests.dev.civicrm.org/trunk/results-api_v3
+*
+* To Learn about the API read
+* http://book.civicrm.org/developer/current/techniques/api/
+*
+* and review the wiki at
+* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
\ No newline at end of file
diff --git a/api/v3/examples/ContributionSoftGet.php b/api/v3/examples/ContributionSoftGet.php
new file mode 100644
index 0000000000..8d4b4766ca
--- /dev/null
+++ b/api/v3/examples/ContributionSoftGet.php
@@ -0,0 +1,63 @@
+<?php
+
+/*
+ 
+ */
+function contribution_soft_get_example(){
+$params = array( 
+  'id' => 1,
+  'version' => 3,
+);
+
+  $result = civicrm_api( 'contribution_soft','get',$params );
+
+  return $result;
+}
+
+/*
+ * Function returns array of result expected from previous function
+ */
+function contribution_soft_get_expectedresult(){
+
+  $expectedResult = array( 
+  'is_error' => 0,
+  'version' => 3,
+  'count' => 1,
+  'id' => 1,
+  'values' => array( 
+      '1' => array( 
+          'id' => '1',
+          'contribution_id' => '1',
+          'contact_id' => '2',
+          'amount' => '10.00',
+          'currency' => 'USD',
+          'pcp_display_in_roll' => 0,
+        ),
+    ),
+);
+
+  return $expectedResult  ;
+}
+
+
+/*
+* This example has been generated from the API test suite. The test that created it is called
+*
+* testGetContributionSoft and can be found in
+* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionSoftTest.php
+*
+* You can see the outcome of the API tests at
+* http://tests.dev.civicrm.org/trunk/results-api_v3
+*
+* To Learn about the API read
+* http://book.civicrm.org/developer/current/techniques/api/
+*
+* and review the wiki at
+* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+*
+* Read more about testing here
+* http://wiki.civicrm.org/confluence/display/CRM/Testing
+*
+* API Standards documentation:
+* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
+*/
\ No newline at end of file
-- 
2.25.1