Participant and Participant Payment APIs

Participant APIs

civicrm_participant_create($params)

Availability: v1.8

This API is used for creating a Participant in an event.

Parameters:

• 'params' (array) an associative array of name/value property values of civicrm_participant

Returns:

• On success, API returns array containing participant id as result.
• On failure, API returns array containing error message
  Create Participant
  Result

civicrm_participant_get($params)

Availability: v1.8

Retrieve a specific participant.If more than one participants exists then return errors
Required parameters : id of participant.

Parameters:

• 'params' (array) an associative array of name/value property values of civicrm_participant

 Returns:

• On success, API returns array of all found participant property values.
• On failure, API returns array with an error id and error message
  Get Participant
  Result

civicrm_participant_search($params)

Availability: v1.8

Retrieve multiple participants.
Required parameters : no required parameters.

Parameters:

• 'params' (array) an associative array of name/value property values of civicrm_participant

 Returns:

• On success, API returns array of participants found each with an array with all participant values .
• On failure, API returns array with an error id and error message
  Get Participant

civicrm_participant_update( $params )

Availability: v1.8

This api is used for updating an existing participant.
Required parrmeters : id of a participant

Parameters:

• 'params' (array) an associative array of name/value property values of civicrm_participant

Returns:

• On success, API returns array of updated participant property values
  Update Participant
  Result

civicrm_participant_delete( $params )

Availability: v1.8

This API is used for deleting an existing contact participant

Parameters:

• 'param' (array) an associative array containing id of participant to be deleted

Returns:

• On success, API returns boolean true
• On failure, API returns array with an error id and error message
  
  Delete Participant
  Result

Participant Payment APIs

civicrm_participant_payment_create($params)

Availability: v1.8

This API is used for creating a Participant Payment of Event.
Required parameters : participant_id, contribution_id.

Parameters:

• 'params' (array) an associative array of name/value property values of civicrm_participant_payment

Returns:

• On success, API returns associative array containing id of newly created participant payment.
• On failure, API returns associative array containing error field
  Create Participant payment
  Result
  set.

civicrm_participant_payment_update( $params )

Availability: v1.8

This api is used for updating an existing participant payment.
Required parrmeters : id of a participant payment

Parameters:

• 'params' (array) an associative array of name/value property values of civicrm_participant_payment

Returns:

• On success,API returns associative array of name/value property values of updated participant payment.
  Update Participant Payment
  Result

civicrm_participant_payment_delete( $participantPaymentID )

Availability: v1.8

This API is used for deleting a participant payment.

Parameters:

• 'params' (array) an associative array containing id of the Participant payment to be deleted

Returns:

• On success, API returns boolean true.
• On failure, API returns array with an error id and error message
  Delete Participant Payment
  Result