Event Grouping OpCode EGL: List Event Groupings

This opcode is used to insert a new Event Grouping entry into the specified show. The Description must be unique and not already exist.

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 EGI 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 to insert the Event Grouping into.
EventGroupingDescription	Varchar 50	Y	The description of this Event Grouping.
EventGroupingDisplayOrder	Integer	N	An integer indicating the order in which this grouping is to be displayed.
EventGroupingImageURL	Varchar 300	N	A URL path to the image to be displayed when rendering this grouping in the system. This should be either relative or use the HTTPS protocol.
EventGroupingAbstract	Varchar 2GB	N	Text description of this grouping that may contain formatted HTML snippets or text.
EventGroupingLanguageAlternates	Varchar 2GB	N	Alternate language translations. Source = 28, Description FieldNo = 1, Abstract FieldNo = 2. See Appendix A for details.

Return Outputs

This API returns the status message OK and the new EventGroupingKey upon successful completion.

Text

### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0

## OpCode=EGI Status=0 Message=OK

EventGroupingKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=EGI&Status=0&Message=OK&EventGroupingKey=123456

XML

<?xml version="1.0" encoding="utf-8" ?>

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
11	Event Grouping Description May Not Be Blank!	The value passed for EventGroupingDescription is blank or the parameter was not supplied.
12	Event Grouping Already Exists!	An Event Grouping with this description already exists. Event Grouping Descriptions must be unique.