Presentation Role Macros OpCode ERL: List Defined Role Macros
Presentation Role Macros OpCode ERL: List Defined Role Macros
This opcode is used to retrieve the list of tenant-defined Role Macros and their values. Role macros are optional and are used for the fast assignment of presenter rights.
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 ERL to invoke this function. |
OutputFormat |
Char 1 |
N |
T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
Return Outputs
This API returns a result set of category information upon successful completion. The result set is structured as follows:
Column |
Type/Size |
---|---|
EventRoleMacroKey |
Integer |
Description |
Varchar 40 |
ModeratorRights |
Integer |
Potential Error Codes
There are no potential error codes for this API call.
Moderator Rights bitmap definition
Bit |
Meaning |
---|---|
4 |
Setup Edit |
8 |
Content Add/Edit/Delete |
16 |
Staff Add/Edit/Delete |
32 |
Source Add/Edit/Delete |
64 |
Start/Stop & Extend Webcast Recording |
128 |
Previous/Next Buttons |
256 |
Tools |
515 |
Broadcast Message |
1024 |
Activity Summary/Reports |
2048 |
Viewer List/Search |
4096 |
Reset Activity |
8192 |
Report Access |
32768 |
Panel Commands |
65536 |
Email On Demand Questions |
131072 |
Notifications |
524288 |
Source List Controls |
1048576 |
Auto Ask For Webcam/Mic |
2097152 |
Combined Source |
4194304 | Producer Tool |
8388608 | Q&A |
16777216 | Profile Edit/Access |
33554432 | Low Latency View (WebRTC) |
67108864 | Override Ending of Screen Share |