New in Telligent Evolution 5.6
Get the details about the roles that are members of the group.
EndpointGETapi.ashx/v2/groups/{groupid}/members/roles/{rolename}.xml (or .json)
EndpointGETapi.ashx/v2/groups/{groupid}/members/roles/{roleid}.xml (or .json)
RequestGroupUserShowRequest
| GroupId |
Required |
GroupId |
| RoleId |
Optional |
Either RoleId or Rolename is required. |
| Rolename |
Optional |
Either RoleId or Rolename is required. |
Example (C#)
var webClient = new WebClient();
// replace the "admin" and "Admin's API key" with your valid user and apikey!
// http://telligent.com/community/developers/w/wiki/how-to-generate-an-api-key.aspx
var adminKey = String.Format("{0}:{1}", "Admin's API Key", "admin");
var adminKeyBase64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(adminKey));
webClient.Headers.Add("Rest-User-Token", adminKeyBase64);
var requestUrl = "http://mysite.com/api.ashx/v2/groups/3/members/roles/1089.xml"; // or .json
var xml = webClient.DownloadString(requestUrl);
Console.WriteLine(xml);
Example Response (XML)
<?xml version="1.0" encoding="utf-8"?>
<Response>
<Info />
<Warnings />
<Errors />
<Role>
<Id>1089</Id>
<Name>Some Role Name</Name>
<Description>description</Description>
<GroupId>53</GroupId>
<IsSystemRole>false</IsSystemRole>
<MembershipType>Member</MembershipType>
</Role>
</Response>
Example Response (JSON)
{
"Role": {
"Name": "Some Role Name",
"Description": "description",
"GroupId": "53",
"IsSystemRole": "false",
"MembershipType": "Member"
"Id": 1089
},
"Info": [],
"Warnings": [],
"Errors": []
}