Usage
Use SessionRegAction to register or unregister invitees and/or guests based on the provided action.
Basic Steps
- Determine the ID of the product (session) for which you want to register or unregister an invitee or guest.
- Construct an ID array and populate it with the IDs of each invitee and/or guest record you want to register or unregister.
- Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes.
- Call SessionRegAction by specifying the ID array, the action you want to take on invitee and/or guest and the product ID.
General Syntax
SessionRegActionResultArray = cventapi. SessionRegAction (CvObjectArray CvObjects, SessionRegActionType SessionRegAction, ID ProductId)Input
| Name | Type | Description |
|---|---|---|
| ProductId | ID | Session from which invitee(s) are getting registered or unregistered. Prod_stub for prod_type_id = 30 (sessions) |
| SessionRegActionType | SessionRegActionType | The action you are taking on the invitees or guests. Valid SessionRegActionType values are Register and Unregister. |
| InviteeId (CvObject Array) | ID | Array of Invitee ID to perform an action on. No more than 200 in an array. |
Output
| Name | Type | Description |
|---|---|---|
| Id | ID | ID of the invitee to Register or Unregister. |
| ReferenceId | String | MessageId input. |
| 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. |
Notes
Take into account the following notes when using the SessionRegAction call:
- Call Limit: Action can only be taken on up to 200 invitees or guests per call.
- Visibility: API user must have visibility to Manage Invitee to make this call.
- Invitee/Guest Status*: Invitee or guest must be in Accepted status.
- Event Status: Event must be in Test Mode, Active, Closed, or Completed status.
Validation Rules
The following validation rules should be applied to the SessionRegAction call:
| Validation Rule | Description |
|---|---|
| Registration Actions | Session must belong to an event that the invitee or guest is registered for. |