list_group_roles
From SmartBots Developers Docs
(Redirected from HTTP API/Bot Commands2/list group roles)
Returns a list the roles in given group.
Variables
The following table shows input values (you send them with the API call) and returned output values.
| Variable | Required | Description | ||
|---|---|---|---|---|
| This API command applies only for Standard bot | ||||
| Input basic parameters: | ||||
| action | yes | = list_group_roles | ||
| apikey | yes | Your personal developer's API key. | ||
| botname | yes | Your bot's SL login. | ||
| secret | yes | Bot access code of your bot. | ||
| dataType | optional | Set to "json" to get JSON reply instead of URL-encoded string | ||
| custom | optional | The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response. | ||
| Input: | ||||
| groupuuid | yes | the UUID of the group | ||
| Output: | ||||
| (to be received in http_response LSL event, see docs for details) | ||||
| result | OK - command completed successfully FAIL - command failed | |||
| resulttext | Detailed reason for the failure. | |||
| custom | The value from input "custom" parameter. See above. | |||
| roles | The list of the role uuids and names, separated by a new-line ("\n") | |||
Example
The roles list is being returned in the following format:
roles=044ad014-7298-eb70-0945-85d6df01f154%3BOwners%0A10d7e54f-7c52-8f0e-7ad8-7e0059664cd0%3BSmartBots%0Aaebb8d51-c3b6-74cb-cc66-9c30584b5542%3BAlive Bots%0Aaef5b7a6-f0c4-b847-5953-1d490f0b3485%3BSupport Bot%0Aeaa86b3b-1408-fb4f-3118-7dadabf65fec%3BPersonal bot%0A00000000-0000-0000-0000-000000000000%3BEveryone
Roles after unescaping routine:
044ad014-7298-eb70-0945-85d6df01f154;Owners 10d7e54f-7c52-8f0e-7ad8-7e0059664cd0;SmartBots aebb8d51-c3b6-74cb-cc66-9c30584b5542;Alive Bots aef5b7a6-f0c4-b847-5953-1d490f0b3485;Support Bot eaa86b3b-1408-fb4f-3118-7dadabf65fec;Personal bot 00000000-0000-0000-0000-000000000000;Everyone
<< return back to Bot commands
(Miss an API call or parameter? Submit your request in forum)
