Event Speaker OpCode ESD: Delete an Event Speaker
Event Speaker OpCode ESD: Delete an Event Speaker
This opcode is used to delete an existing Event Speaker entry in the specified show. Any events that are associated with this speaker will be reset to speaker-less presentations. The Speaker entry to delete can be identified by passing the Event Speaker Key, Speaker Show User Key, Speaker Email Address, or the Speaker Display Name. The associated Show User is NOT deleted.
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 ESD 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. |
Return Outputs
This API returns the status message OK upon successful completion.
Text
### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0
## OpCode=ESD Status=0 Message=OK
HTTP URL-encoded
APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=ESD&Status=0&Message=OK
XML
<?xml version="1.0" encoding="utf-8" ?>
<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >
<OpCodeResult OpCode="ESD" Status="0" Message="OK" />
</APIResults>
Potential Error Codes
Error |
Message |
Reason |
---|---|---|
25 |
Event Speaker Associated Not Found! |
The function could not find a matching speaker entry based on the values supplied in EventSpeakerKey, SpeakerShowUserKey, SpeakerEMailAddress, or SpeakerDisplayName. |