Usage
Use ValidateInvitee to check whether an invitee is eligible to attend an event or a session.
Basic Steps
- Determine the type and ID of the product for which you want validate the invitee.
- Construct an array of InviteeIDs that need to be validated.
- Optionally, specify if you want to check if the invitee has made full payment for the product.
- Call ValidateInvitee, passing in the ProductID and array of InviteeIDs.
- Process the results in the ValidateInviteeResultArray to verify whether the answers have been successfully validated.
General Syntax
ValidateInviteeResultArray = cventapi.ValidateInvitee(ProductType, ProductID, CheckPaidInFull, CvObjectArray)Input
| Name | Type | Description |
|---|---|---|
| ProductType | Enumerator type (Event/Session) | Indicates type of product (event or session). |
| ProductID | ID | Indicates the session or event for which an invitee is being checked. |
| CheckPaidInFull | Boolean | If True, Cvent will check whether the invitee has made full payment for session or event. If False, payment information will not be checked. |
| CvObjectArray | CvObjectArray | Array of Invitee IDs that need to be checked. |
Output
| Name | Type | Description |
|---|---|---|
| ReferenceId | String | MessageId input. |
| InviteeID | ID | ID of invitee that was validated. |
| Registered | Boolean | Indicates whether the invitee has registered (TRUE) or not (FALSE). |
| PaidInFull | Boolean | Indicates whether the invitee has made full payment (TRUE) or not (FALSE). |
| CheckedIn | Boolean | Indicates whether the invitee has been marked as participant (TRUE) or not (FALSE). |
| Success | Boolean | Indicates whether the action taken was successful (TRUE) or not (FALSE) for the object instance. |
| Errors | Error Array | If an error occurred when the action was taken, an array of one or more Error objects providing the error code and description. |
Last updated on