ParticipantStatusType.php
This api exposes CiviCRM participant status options.
Table of Contents
Functions
- civicrm_api3_participant_status_type_create() : array<string|int, mixed>
- Create/update participant_status.
- civicrm_api3_participant_status_type_get() : array<string|int, mixed>
- Returns array of participant_statuses matching a set of one or more group properties.
- civicrm_api3_participant_status_type_delete() : array<string|int, mixed>
- Delete an existing participant_status.
Functions
civicrm_api3_participant_status_type_create()
Create/update participant_status.
civicrm_api3_participant_status_type_create(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used to create new participant_status or update any of the existing In case of updating existing participant_status, id of that particular participant_status must be in $params array.
Parameters
- $params : array<string|int, mixed>
-
name/value pairs to insert in new 'participant_status'
Return values
array<string|int, mixed> —participant_status array
civicrm_api3_participant_status_type_get()
Returns array of participant_statuses matching a set of one or more group properties.
civicrm_api3_participant_status_type_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of properties. If empty, all records will be returned.
Return values
array<string|int, mixed> —Array of matching participant_statuses
civicrm_api3_participant_status_type_delete()
Delete an existing participant_status.
civicrm_api3_participant_status_type_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This method is used to delete any existing participant_status given its id.
Parameters
- $params : array<string|int, mixed>
-
[id]
Tags
Return values
array<string|int, mixed> —api result array