Event OpCode EEC: Create or Update an Event
Event OpCode EEC: Create or Update an Event
This opcode is used to update an existing event in the specified show, if it exists, or create a new event. The event to update may be identified by specifying the EventKey, EventDescription, or EventCode. When updating existing events, omitted or empty parameters are ignored.
Each event that is created must be created under a valid Event Type (Event Provider – see OpCode EPL) and a valid Event Grouping (see OpCode EGL). Either the actual key values may be passed in the EventTypeKey/EventGroupingKey parameters, or the description may be passed in the EventTypeDescription/EventGroupingDescription parameters and the system will look up the key values.
Each event that is created may be created in a specific booth (in-booth presentation). If creating an in-booth presentation, either the actual booth key value may be passed in the BoothKey parameter, or the booth Title may be passed in the EventBoothTitle parameter and the system will look up the booth key value. Alternatively, the Booth External ID may be used in the EventBoothExternalID parameter.
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation (except for file uploading which requires a multi-part form post). Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.
The format of the API call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50540&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&ShowKey={ShowKey}&{Additional, opcode-specific parameters in name=value format…}
Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50540. All other parameters may appear in any sequence order.
|
API Parameter |
Type/Size |
Req. |
Comment |
|---|---|---|---|
|
APIUserAuthCode |
Varchar 80 |
Y |
Your API authorization code as supplied by Notified. |
|
APIUserCredentials |
Varchar 80 |
Y |
Your API user credentials as supplied by Notified. |
|
OpCodeList |
Varchar 20 |
Y |
Should include EEC to invoke this function. |
|
OutputFormat |
Char 1 |
N |
T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
|
ShowKey |
Integer |
Y |
The ShowKey that the Event belongs to. |
|
EventKey |
Integer |
N |
The event key to update. |
|
EventCode |
Varchar 255 |
N |
The event code. |
|
EventDatesFromDateTime |
Datetime |
N |
Beginning date/time of the Event. Must be in YYYY-MM-DD HH:MI:SS format. Required if create is called. |
|
EventDatesToDateTime |
Datetime |
N |
Ending date/time of the Event. Must be in YYYY-MM-DD HH:MI:SS format. Defaults to 30 minutes from FromDateTime if not specified. |
|
EventDescription |
Varchar 355 |
N |
The description of the event. |
|
EventAbstract |
Varchar 2GB |
N |
Text description of this event that may contain formatted HTML snippets or text. |
|
EventTypeKey |
Integer |
N |
A valid Event Provider Type key, or pass the Event Provider Type description in EventTypeDescription and the system will look it up based on the description. |
|
EventTypeDescription |
Varchar 128 |
N |
Description of a valid Event Provider Type. |
|
EventGroupingKey |
Integer |
N |
A valid Event Grouping key, or pass the Event Grouping description in EventGroupingDescription and the system will look it up based on the description. |
|
EventGroupingDescription |
Varchar 50 |
N |
Description of a valid Event Grouping. |
|
EventSpeakerKey |
Integer |
N |
Event speaker associated with this event (see OpCode ESL). |
|
EventRuntimeDuration |
Varchar 40 |
N |
Display information regarding runtime of presentation. Free-form text. (Ex: Approx. 20 minutes) |
|
EventEarlyEntranceMinutes |
Integer |
N |
The number of minutes viewers can access the event before the actual start time. |
|
EventCode |
Varchar 255 |
N |
Session ID or external system linkage. (Ex: BRK-001) |
|
EventIconImage |
Varchar 255 |
N |
A URL path to the image to be displayed when rendering this event in the system. This should be either relative or use the HTTPS protocol. |
|
EventParamBlock |
Varchar 2GB |
N |
Configuration data specific to this event. See Appendix B for details on the format for various Event Providers. |
|
EventRequiresRegistration |
Bit (0/1) |
N |
Flag indicating whether this event requires registration package authorization to view. |
|
EventActive |
Bit (0/1) |
N |
Flag indicating whether this event is active. 0 = Inactive, 1 = Active. |
|
EventLaunchNewWindow |
Bit (0/1) |
N |
Flag indicating whether this event should be launched in a new window. |
|
EventFullscreen |
Bit (0/1) |
N |
Flag indicating whether this event should be shown in IE-specific fullscreen theater mode. (Only applicable if EventLaunchNewWindow = 1) |
|
EventIsOnDemand |
Bit (0/1) |
N |
Flag indicating whether this event is a live/scheduled event (value=0) or an on-demand event (value=1). |
|
EventNewWindowWidth |
Integer |
N |
A value specifying the window width, in pixels, when launching an event in a new window. |
|
EventNewWindowHeight |
Integer |
N |
A value specifying the window height, in pixels, when launching an event in a new window. |
|
EventBoothKey |
Integer |
N |
Booth key to create the event under (in-booth presentation). |
|
EventBoothTitle |
Varchar 128 |
N |
Booth Title to create the event under, if booth key is unknown (in-booth presentation). |
|
EventBoothExternalID |
Varchar 255 |
N |
Booth External ID to create the event under if booth key unknown (in-booth presentation). |
|
EventCustomSortOrder |
Integer |
N |
Value controlling the sort order when listing events. |
|
EventExitAction |
Integer |
N |
Exit action to perform when the event ends. Values are: |
|
EventExitData |
Varchar 1000 |
N |
Command information varying depending upon the ExitAction ID. |
|
EventExitActionTarget |
Varchar 100 |
N |
Window target to navigate. Standard values include ShowFloorFrame, _blank, _top, _parent. |
|
EventSubjectCategoryKey |
Integer |
N |
Subject Category of this event. (See OpCode SCL) |
|
EventCategory |
Integer |
N |
Category of this event. (See OpCode CTL) |
|
EventMaxConcurrentViewers |
Integer |
N |
The maximum number of viewers that can be in this event simultaneously. |
|
EventDescriptionAlts |
Varchar 2GB |
N |
Alternate language translations. Source = 7, Description FieldNo = 1, Abstract FieldNo = 2. See Appendix A for format. |
|
EventAbstractAlts |
Varchar 2GB |
N |
Alternate language translations. Source = 7, Description FieldNo = 1, Abstract FieldNo = 2. See Appendix A for format. |
|
EventKeywords |
Varchar 400 |
N |
Keywords that are used in the search to help locate this event. |
|
EventLocaleID |
Integer |
N |
Locale ID indicating the language of this event. (See Locale ID reference in the External User API documentation for a list of values) |
|
EventUDFList |
Varchar 2GB |
N |
User-defined field data for this event. (See Passing UDF Values reference in the External User API documentation for format details) |
|
EventSecondScreen |
Integer |
N |
Second Screen States |
Return Outputs
See the descriptions of OpCodes EEI and EEU for more information on the return completion results.
Potential Error Codes
See the descriptions of OpCodes EEI and EEU for more information on the potential error codes.