Retrieves the list of Event Manager Roles and their associated permissions
Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
---|---|---|---|
None. | SRTeamraiserAPI | POST | Yes. |
This Server API method returns information about TeamRaiser Event Manager Roles defined in the system. Use it in conjunction with the addTeamraiserEventManager or listTeamraiserEventManagers methods to cross-reference a TeamRaiser Event Manager Role with its corresponding role_id.
API Administrator accounts that access this API must be assigned TeamRaiser API User permission under the TeamRaiser Management permission type.
See topic Common Parameters.
See topic HTTP Status Codes.
XML response<?xml version="1.0" encoding="UTF-8"?> <getTeamraiserEventManagerRolesResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <totalNumberResults>2</totalNumberResults> <eventManagerRole> <role_id>0</role_id> <role_name>Sample Event Manager Role 01</role_name> <permission> <permission_name>Sample Permission 01_01</permission_name> <allowed>true</allowed> </permission> <permission> <permission_name>Sample Permission 01_11</permission_name> <allowed>false</allowed> </permission> <permission> <permission_name>Sample Permission 01_21</permission_name> <allowed>true</allowed> </permission> <permission> <permission_name>Sample Permission 01_31</permission_name> <allowed>false</allowed> </permission> <permission> <permission_name>Sample Permission 01_41</permission_name> <allowed>true</allowed> </permission> </eventManagerRole> <eventManagerRole> <role_id>1</role_id> <role_name>Sample Event Manager Role 11</role_name> <permission> <permission_name>Sample Permission 11_01</permission_name> <allowed>true</allowed> </permission> <permission> <permission_name>Sample Permission 11_11</permission_name> <allowed>false</allowed> </permission> <permission> <permission_name>Sample Permission 11_21</permission_name> <allowed>true</allowed> </permission> <permission> <permission_name>Sample Permission 11_31</permission_name> <allowed>false</allowed> </permission> <permission> <permission_name>Sample Permission 11_41</permission_name> <allowed>true</allowed> </permission> </eventManagerRole> </getTeamraiserEventManagerRolesResponse>JSON response
{"getTeamraiserEventManagerRolesResponse":{"totalNumberResults":"2","eventManagerRole":[{"role_id":"0","permission":[{"allowed":"true","permission_name":"Sample Permission 01_01"},{"allowed":"false","permission_name":"Sample Permission 01_11"},{"allowed":"true","permission_name":"Sample Permission 01_21"},{"allowed":"false","permission_name":"Sample Permission 01_31"},{"allowed":"true","permission_name":"Sample Permission 01_41"}],"role_name":"Sample Event Manager Role 01"},{"role_id":"1","permission":[{"allowed":"true","permission_name":"Sample Permission 11_01"},{"allowed":"false","permission_name":"Sample Permission 11_11"},{"allowed":"true","permission_name":"Sample Permission 11_21"},{"allowed":"false","permission_name":"Sample Permission 11_31"},{"allowed":"true","permission_name":"Sample Permission 11_41"}],"role_name":"Sample Event Manager Role 11"}]}}