Event Providers OpCode EPL – List Valid Event Providers

Event Providers OpCode EPL – List Valid Event Providers

This opcode is used to retrieve the list of authorized Event Providers defined for the specified show. Event Providers are internal and external webcasting platforms and integrations. Examples include XpoCast, Webex, and On24.

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 2000

Y

Should include EPL 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 list Event Providers for.

Return Outputs

This API returns a result set of event provider information upon successful completion. The result set is structured as:

Column

Type/Size

EventTypeKey

Integer

Description

Varchar 128

InternalID

Integer

 

Potential Error Codes

There are no potential error codes for this API call.