Event Track OpCode ETI: Add a New Event Track

This opcode is used to insert a new Event Track entry into the specified show. Tracks are also referred to as Packages. The EventPackageDescription 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 ETI 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 create the Event Track in.
EventPackageDescription	Varchar 255	Y	The description of this track.
EventPackageDisplayOrder	Integer	N	Display order for this track.
EventPackageImageURL	Varchar 300	N	A URL path to the image to be displayed when rendering this track in the system. This should be either relative or use the HTTPS protocol.
EventPackageAbstract	Varchar 2GB	N	Text description of this track that may contain formatted HTML snippets or text.
EventPackageLanguageAlternates	Varchar 2GB	N	Alternate language translations. Source = 38, Description FieldNo = 1, Abstract FieldNo = 2. See Appendix A for details.

Return Outputs

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

Text

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

## OpCode=ETI Status=0 Message=OK

EventPackageKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=ETI&Status=0&Message=OK&EventPackageKey=123456

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
31	Event Track Description May Not Be Blank!	The EventTrackDescription was blank or omitted. The description must have a value.
32	Event Track Already Exists!	Descriptions must be unique.