Event Grouping OpCode EGD: Delete an Event Grouping

This opcode is used to delete an Event Grouping entry in the specified show. The Grouping item to delete may be identified using either the EventGroupingKey or the Description. When using the Description, either omit the EventGroupingKey parameter or pass a value of zero (0).

WARNING: Deleting an Event Grouping will delete all Events associated with this grouping.

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 EGD 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 delete the Event Grouping from.
EventGroupingKey	Integer	N	EventGroupingKey that identifies the entry to delete.
EventGroupingDescription	Varchar 50	N	The description of this Event Grouping.

Return Outputs

This API returns the status message OK upon successful completion.

Text

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

## OpCode=EGD Status=0 Message=OK

HTTP URL-encoded

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

XML

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

</APIResults>

Potential Error Codes

Error	Message	Reason
15	Event Grouping Does Not Exist!	The Event Grouping could not be identified using the supplied values for EventGroupingKey or Description.