Event Grouping OpCode EGC: Create or Update an Event Grouping

This opcode is used to update an Event Grouping entry in the specified show, if it exists, or create a new one if it does not. The Grouping item is identified using either the EventGroupingKey or the Description. When using the Description, either omit the EventGroupingKey parameter or pass a value of 0. If the Event Grouping is found using the key or description, the Update An Event Grouping API is called OpCode EGU. Otherwise, the Add An Event Grouping API is called OpCode EGI.

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.

Return Outputs

See the descriptions of OpCodes EGI and EGU for more information on the return completion results.

Potential Error Codes

See the descriptions of OpCodes EGI and EGU for more information on the potential error codes.