Participant.php
This api exposes CiviCRM participant.
Table of Contents
Functions
- civicrm_api3_participant_create() : array<string|int, mixed>
- Create an Event Participant.
- _civicrm_api3_participant_createlineitem() : mixed
- Create a default participant line item.
- _civicrm_api3_participant_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_participant_get() : array<string|int, mixed>
- Retrieve a specific participant, given a set of input params.
- _civicrm_api3_participant_get_spec() : mixed
- Adjust Metadata for Get action.
- civicrm_api3_participant_delete() : array<string|int, mixed>
- Deletes an existing contact participant.
Functions
civicrm_api3_participant_create()
Create an Event Participant.
civicrm_api3_participant_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
An associative array of name/value property values of civicrm_participant.
Tags
Return values
array<string|int, mixed> —API result array
_civicrm_api3_participant_createlineitem()
Create a default participant line item.
_civicrm_api3_participant_createlineitem(array<string|int, mixed> &$params, CRM_Event_BAO_Participant $participant) : mixed
Parameters
- $params : array<string|int, mixed>
- $participant : CRM_Event_BAO_Participant
Tags
_civicrm_api3_participant_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_participant_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_participant_get()
Retrieve a specific participant, given a set of input params.
civicrm_api3_participant_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
input parameters.
Return values
array<string|int, mixed> —array of properties, if error an array with an error id and error message
_civicrm_api3_participant_get_spec()
Adjust Metadata for Get action.
_civicrm_api3_participant_get_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_participant_delete()
Deletes an existing contact participant.
civicrm_api3_participant_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for deleting a contact participant
Parameters
- $params : array<string|int, mixed>
-
Array containing Id of the contact participant to be deleted.