Event Speaker OpCode ESC: Create or Update an Event Speaker

Event Speaker OpCode ESC: Create or Update an Event Speaker

This opcode is used to update an existing Event Speaker entry in the specified show, if found, or to create a new one. The SpeakerDisplayName must be unique and not already exist outside the entry to update. The Show User associated with this speaker entry must already exist in the system and may be identified by either specifying the SpeakerShowUserKey, SpeakerEMailAddress or by matching the SpeakerDisplayName with an existing user with that same name attribute. Note that a Show User may only be associated with a single speaker entry for a given show. The Speaker entry to potentially update can be identified by passing the Event Speaker Key, Speaker Show User Key, Speaker Email Address, or the Speaker Display Name.

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 ESC 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 insert the Event Speaker into.

EventSpeakerKey

Integer

N

The Event Speaker key value to update.

SpeakerShowUserKey

Integer

N

The Show User Key identifies the user in the system that this speaker entry is associated with.

SpeakerEMailAddress

Varchar 255

N

The email address that identifies the user in the system that this speaker entry is associated with.

SpeakerDisplayName

Varchar 80

N

Display Description for this speaker. If blank or omitted, defaults to show username.

SpeakerBio

Varchar 300

N

Text description of this grouping that may contain formatted HTML snippets or text.

SpeakerPhotoURL

Varchar 256

N

A URL path to the image to be displayed when rendering this grouping in the system. This should be either relative or use the HTTPS protocol.

SpeakerDisplayNameAlts

Varchar 2GB

N

Alternate language translations for Display Name. Source = 13, DisplayName FieldNo = 1, SpeakerBio FieldNo = 2. See Appendix A for details.

SpeakerBioAlts

Varchar 2GB

N

Alternate language translations for Bio. Source = 13, DisplayName FieldNo = 1, SpeakerBio FieldNo = 2.

Return Outputs

 

See the descriptions of OpCodes ESI and ESU for more information on the return completion results.

 

Potential Error Codes

 

See the descriptions of OpCodes ESI and ESU for more information on the potential error codes.