Event Moderators OpCode EMI: Add Moderator/Staffer to an Event
Event Moderators OpCode EMI: Add Moderator/Staffer to an Event
This opcode is used to add an existing Show User as a moderator or staffer to an existing Event in the specified show. The Event to add this staffer to may be identified by specifying the EventKey, EventCode, or EventDescription. The user to add may be identified by specifying either the ShowUserKey in StaffShowUserKey or the user’s email address in StaffEMailAddress.
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 EMI 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 that the Event belongs to. |
EventKey |
Integer |
N |
The event key to add the staffer to. |
EventCode |
Varchar 255 |
N |
The event code to add the staffer to. |
EventDescription |
Varchar 355 |
N |
The description of the event to add the staffer to. |
StaffShowUserKey |
Integer |
N |
The Show User Key of the user to add as a staffer. |
StaffEMailAddress |
Varchar 255 |
N |
The email address of the show user to add as a staffer. |
StaffModeratorRights |
Integer |
N |
Bitmap flags describing the rights for this staffer. See EML for definition. |
StaffPhotoURL |
Varchar 256 |
N |
The photo URL of the staffer. |
StaffDisplayOrder |
Integer |
N |
The number index used to sort this staffer relative to other staffers. |
Return Outputs
This API returns the status message OK and the EventStaffKey and EventKey upon successful completion.
Text
### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0
## OpCode=EMI Status=0 Message=OK
EventStaffKey,EventKey
123456,7890
HTTP URL-encoded
APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=EMI&Status=0&Message=OK&EventStaffKey=123456&EventKey=7890
XML
<?xml version="1.0" encoding="utf-8" ?>
<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >
<OpCodeResult OpCode="EMI" Status="0" Message="OK" >
<ResultRow>
<EventStaffKey>123456</EventStaffKey>
<EventKey>7890</EventKey>
<SpeakerID>B77F46E9-95A9-4307-83B2-800D063E13AD</SpeakerID>
</ResultRow>
</OpCodeResult>
</APIResults>
Potential Error Codes
Error |
Message |
Reason |
---|---|---|
41 |
Event Not Found! |
The function could not find a matching event entry based on the values supplied in EventKey, EventCode, or EventDescription. |
42 |
Show User Not Found! |
The function could not find a matching Show User based on the values supplied in StaffShowUserKey or StaffEMailAddress. |
43 |
Show User Already Staffed To This Event! |
The specified show user is already a staffer for this event. Users may only be staffed once. |