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();
25 'error' => $errorMessage,
26 'error_code' => $errorCode,
27 'error_data' => $errorData,
35 * Function returns array of result expected from previous function.
40 function participant_get_expectedresult() {
42 $expectedResult = array(
49 'contact_type' => 'Individual',
50 'contact_sub_type' => '',
51 'sort_name' => 'Anderson, Anthony',
52 'display_name' => 'Mr. Anthony Anderson II',
54 'event_title' => 'Annual CiviCRM meet',
55 'event_start_date' => '2013-07-29 00:00:00',
56 'event_end_date' => '2013-08-04 00:00:00',
57 'participant_id' => '2',
58 'participant_fee_level' => '',
59 'participant_fee_amount' => '',
60 'participant_fee_currency' => '',
61 'event_type' => 'Conference',
62 'participant_status_id' => '2',
63 'participant_status' => 'Attended',
64 'participant_role' => 'Attendee',
65 'participant_role_id' => '1',
66 'participant_register_date' => '2007-02-19 00:00:00',
67 'participant_source' => 'Wimbeldon',
68 'participant_note' => '',
69 'participant_is_pay_later' => 0,
70 'participant_is_test' => 0,
71 'participant_registered_by_id' => '',
72 'participant_discount_name' => '',
73 'participant_campaign_id' => '',
75 'api.participant.delete' => array(
84 'contact_type' => 'Individual',
85 'contact_sub_type' => '',
86 'sort_name' => 'Anderson, Anthony',
87 'display_name' => 'Mr. Anthony Anderson II',
89 'event_title' => 'Annual CiviCRM meet',
90 'event_start_date' => '2013-07-29 00:00:00',
91 'event_end_date' => '2013-08-04 00:00:00',
92 'participant_id' => '3',
93 'participant_fee_level' => '',
94 'participant_fee_amount' => '',
95 'participant_fee_currency' => '',
96 'event_type' => 'Conference',
97 'participant_status_id' => '2',
98 'participant_status' => 'Attended',
99 'participant_role' => 'Attendee',
100 'participant_role_id' => '1',
101 'participant_register_date' => '2007-02-19 00:00:00',
102 'participant_source' => 'Wimbeldon',
103 'participant_note' => '',
104 'participant_is_pay_later' => 0,
105 'participant_is_test' => 0,
106 'participant_registered_by_id' => '',
107 'participant_discount_name' => '',
108 'participant_campaign_id' => '',
110 'api.participant.delete' => array(
120 return $expectedResult;
124 * This example has been generated from the API test suite.
125 * The test that created it is called "testNestedDelete"
126 * and can be found at:
127 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantTest.php
129 * You can see the outcome of the API tests at
130 * https://test.civicrm.org/job/CiviCRM-master-git/
132 * To Learn about the API read
133 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
135 * Browse the api on your own site with the api explorer
136 * http://MYSITE.ORG/path/to/civicrm/api
138 * Read more about testing here
139 * http://wiki.civicrm.org/confluence/display/CRM/Testing
141 * API Standards documentation:
142 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards