Event Track OpCode ETR: Remove an Event from an Event Track

This opcode is used to remove an existing event as a member from an existing Event Track in the specified show. Tracks are also referred to as Packages. Events may be associated with multiple tracks. The Event Track to remove the event from may be identified either by specifying the EventPackageKey or the EventPackageDescription. The Event to remove may be identified by specifying the EventKey, EventCode, or EventDescription.

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 ETR 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 Track belongs to.
EventPackageKey	Integer	N	The key value of the track to update.
EventPackageDescription	Varchar 255	N	The description of this track.
EventKey	Integer	N	The event key to remove from this track.
EventCode	Varchar 255	N	The event code to remove from this track.
EventDescription	Varchar 355	N	The description of the event to remove from this track.

Return Outputs

This API returns the status message OK upon successful completion.

Text

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

## OpCode=ETR Status=0 Message=OK

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=ETR&Status=0&Message=OK

XML

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

</APIResults>

Potential Error Codes

Error	Message	Reason
33	Event Track Does Not Exist!	The function could not find a matching track entry based on the values supplied in EventPackageKey and EventTrackDescription.
34	Event Not Found!	The function could not find a matching event entry based on the values supplied in EventKey, EventCode, or EventDescription.