+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*/
/**
- * File for the CiviCRM APIv3 participant functions
+ * This api exposes CiviCRM participant payments.
*
* @package CiviCRM_APIv3
- * @subpackage API_Participant
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Participant.php 30486 2010-11-02 16:12:09Z shot $
- *
*/
/**
- * Create a Event Participant Payment
+ * Create a Event Participant Payment.
*
* This API is used for creating a Participant Payment of Event.
- * Required parameters : participant_id, contribution_id.
+ * Required parameters: participant_id, contribution_id.
*
* @param array $params
* An associative array of name/value property values of civicrm_participant_payment.
*
* @return array
- * Array of newly created payment property values.
*/
function civicrm_api3_participant_payment_create($params) {
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_participant_payment_create_spec(&$params) {
$params['participant_id']['api.required'] = 1;
}
/**
- * Deletes an existing Participant Payment
- *
- * This API is used for deleting a Participant Payment
+ * Deletes an existing Participant Payment.
*
* @param array $params
*
* @return array
* API result
- * @example ParticipantPaymentDelete.php
- * {@getfields ParticipantPayment_delete}
*/
function civicrm_api3_participant_payment_delete($params) {
$participant = new CRM_Event_BAO_ParticipantPayment();
}
/**
- * Retrieve one / all contribution(s) / participant(s) linked to a
- * contribution.
+ * Retrieve one or more participant payment records.
*
* @param array $params
* Input parameters.
*
* @return array
* array of properties, if error an array with an error id and error message
- * @example ParticipantPaymentGet
- * {@getfields ParticipantPayment_get}
*/
function civicrm_api3_participant_payment_get($params) {
return _civicrm_api3_basic_get('CRM_Event_DAO_ParticipantPayment', $params);