getRoleById

Purpose

Returns information about the specified role in XML or JSON format. Throws an exception if roleId evaluates to Super Admin.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getRoleById

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

roleId

The original ID of the role.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

Full administrative privileges.

Response

The integration code, name, description, ID, and original ID of the role in XML or JSON format.

Example

Output example in XML format:

<?xml version="1.0" encoding="UTF-8" ?>
<resp status="ok">
    <role>
        <name>Administrator</name>
        <description>System Administrator has unrestricted access to all applications.</description>
        <id>90</id>
        <originalId>90</originalId>
    </role>
</resp>

Output example in JSON format:

{
  "code": null,
  "name": "Administrator",
  "description": "System Administrator has unrestricted access to all applications.",
  "id": "90",
  "originalId": "90"
}