3 * Test Generated example demonstrating the Participant.get API.
5 * Criteria delete by nesting a GET & a DELETE.
10 function participant_get_example() {
13 'api.participant.delete' => 1,
17 $result = civicrm_api3('Participant', 'get', $params);
19 catch (CiviCRM_API3_Exception
$e) {
21 $errorMessage = $e->getMessage();
22 $errorCode = $e->getErrorCode();
23 $errorData = $e->getExtraParams();
26 'error_message' => $errorMessage,
27 'error_code' => $errorCode,
28 'error_data' => $errorData,
36 * Function returns array of result expected from previous function.
41 function participant_get_expectedresult() {
43 $expectedResult = array(
50 'contact_type' => 'Individual',
51 'contact_sub_type' => '',
52 'sort_name' => 'Anderson, Anthony',
53 'display_name' => 'Mr. Anthony Anderson II',
55 'event_title' => 'Annual CiviCRM meet',
56 'event_start_date' => '2013-07-29 00:00:00',
57 'event_end_date' => '2013-08-04 00:00:00',
58 'participant_id' => '2',
59 'participant_fee_level' => '',
60 'participant_fee_amount' => '',
61 'participant_fee_currency' => '',
62 'event_type' => 'Conference',
63 'participant_status_id' => '2',
64 'participant_status' => 'Attended',
65 'participant_role_id' => '1',
66 'participant_role' => 'Attendee',
67 'participant_register_date' => '2007-02-19 00:00:00',
68 'participant_source' => 'Wimbeldon',
69 'participant_note' => '',
70 'participant_is_pay_later' => 0,
71 'participant_is_test' => 0,
72 'participant_registered_by_id' => '1',
73 'participant_discount_name' => '',
74 'participant_campaign_id' => '',
76 'api.participant.delete' => array(
85 'contact_type' => 'Individual',
86 'contact_sub_type' => '',
87 'sort_name' => 'Anderson, Anthony',
88 'display_name' => 'Mr. Anthony Anderson II',
90 'event_title' => 'Annual CiviCRM meet',
91 'event_start_date' => '2013-07-29 00:00:00',
92 'event_end_date' => '2013-08-04 00:00:00',
93 'participant_id' => '3',
94 'participant_fee_level' => '',
95 'participant_fee_amount' => '',
96 'participant_fee_currency' => '',
97 'event_type' => 'Conference',
98 'participant_status_id' => '2',
99 'participant_status' => 'Attended',
100 'participant_role_id' => '1',
101 'participant_role' => 'Attendee',
102 'participant_register_date' => '2007-02-19 00:00:00',
103 'participant_source' => 'Wimbeldon',
104 'participant_note' => '',
105 'participant_is_pay_later' => 0,
106 'participant_is_test' => 0,
107 'participant_registered_by_id' => '',
108 'participant_discount_name' => '',
109 'participant_campaign_id' => '',
111 'api.participant.delete' => array(
121 return $expectedResult;
125 * This example has been generated from the API test suite.
126 * The test that created it is called "testNestedDelete"
127 * and can be found at:
128 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php
130 * You can see the outcome of the API tests at
131 * https://test.civicrm.org/job/CiviCRM-master-git/
133 * To Learn about the API read
134 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
136 * Browse the api on your own site with the api explorer
137 * http://MYSITE.ORG/path/to/civicrm/api
139 * Read more about testing here
140 * http://wiki.civicrm.org/confluence/display/CRM/Testing
142 * API Standards documentation:
143 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards