Loading ...

REST API: Get Role | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: User Roles » REST API: Get Role
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 16

REST API: Get Role

4.93 
 /5
4.93 (2votes)

Please Note This method gets a role from the Top Level Community. See  REST API: Get Space Role  for how to get a space role via REST API.

Get Role

GET /api/roles/{RoleID}

Get a top level role. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
RoleID

 Used in the request URL as a path parameter Unique identifier for a particular role.

Example Request

GET https://myintranet.communifire.com/api/roles/64

Example Response

Role JSON object is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":{ 
        "RoleID":64,
        "UserID":0,
        "SpaceID":0,
        "RoleName":"Quality Analyst",
        "Description":"Software quality analyst",
        "RoleImageFileName":null
    }
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software