Usage
Use CreateSession
to add one or more sessions to your Cvent event. The CreateSession
call is analogous to the INSERT
statement in SQL.
Basic Steps
- Create an instance of one or more individual session objects. For each session object, you populate its fields with the data you want to add.
- Construct a Session array and populate that array with the sessions you want to create.
- 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
CreateSession
, passing in the Session array. Process the results in theCreateSessionResultArray
object to verify whether the sessions have been successfully created.
General Syntax
CreateSessionResultArray = cventapi.CreateSession (SessionArray)
Input
Name | Type | Description |
---|---|---|
EventId | ID | The ID of the event where the session is to be created. |
Session | SessionDetails Array | An array of up to 200 products (sessions) to be created. The ProductType does not need to be specified, but if supplied must = 30. Any other value for ProductType should return an error. |
Output
Name | Type | Description |
---|---|---|
Id | ID | ID of the Session that you attempted to create. Returned blank if creation was unsuccessful. |
ReferenceId | String | MessageID value for the input. |
Success | Boolean | Indicates whether the Create call succeeded or failed (true/false). |
Errors | Error Array | If an error occurred during the Create call, an array of one of more Error objects providing the error code and description. |
Validations Rules
The following validation rules should be applied to the CreateSession
call:
Format and Pattern | The ID field should be a valid GUID data type. |
---|---|
Referential Integrity | StartTime must be before EndTime. |
Length | The application will truncate data which exceeds the maximum length of a field. |
Read-Only | The application will ignore the value in the read-only fields. |
Last updated on