Get Role by ID documentgenerator.role.get

Scope: documentgenerator

Who can execute the method: user with permission to modify document generator settings

The method documentgenerator.role.get returns information about the role and its access permissions.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Role identifier.

You can obtain the identifier after creating a role or by using the get role list method

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":9}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":9,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.role.get

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.role.get',
                {
                    id: 9
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.role.get',
                [
                    'id' => 9,
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.role.get',
            {
                id: 9
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.role.get',
            [
                'id' => 9,
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "role": {
                    "id": 9,
                    "name": "Template Editors",
                    "code": "DOCGEN_TEMPLATE_EDITORS",
                    "permissions": {
                        "settings": {
                            "modify": ""
                        },
                        "templates": {
                            "modify": "A"
                        },
                        "documents": {
                            "modify": "X",
                            "view": "X"
                        }
                    }
                }
            },
            "time": {
                "start": 1774014973,
                "finish": 1774014974.093322,
                "duration": 1.0933220386505127,
                "processing": 0,
                "date_start": "2026-03-20T16:56:13+02:00",
                "date_finish": "2026-03-20T16:56:14+02:00",
                "operating_reset_at": 1774015574,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response (detailed description)
time `time`	Information about the request execution time

Result Object

Name `type`	Description
role `object`	Role data (detailed description)

Role Object

Name `type`	Description
id `integer`	Role identifier
name `string`	Role name
code `string`	Symbolic code of the role
permissions `object`	Role permissions (detailed description)

Permissions Object

Name `type`	Description
settings `object`	Permissions for settings (detailed description)
templates `object`	Permissions for templates (detailed description)
documents `object`	Permissions for documents (detailed description)

Settings Object

Name
type

Description

modify
string

Access level to settings. Possible values:

"" — no access
X — full access

Templates Object

Name
type

Description

modify
string

Access level to templates. Possible values:

"" — no access
A — only own items
D — own and department colleagues
X — full access

Documents Object

Name
type

Description

modify
string

Access level to modify documents. Possible values:

"" — no access
X — full access

view
string

Access level to view documents. Possible values:

"" — no access
X — full access

Error Handling

HTTP Status: 400, 403

{
            "error": "0",
            "error_description": "You do not have permissions to modify settings"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`100`	Bitrix\DocumentGenerator\Model\Role All parameters in the constructor must have real class type	Required parameter `id` not provided
`400`	`100`	Could not construct parameter	Non-existent parameter `id` provided
`400`	`0`	You do not have permissions to modify settings	Insufficient permissions to modify document generator settings
`403`	`DOCGEN_ACCESS_ERROR`	Your plan does not support this operation	The plan does not support the function of permission delimitation for the document generator

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Update Role

Get List of Roles

Get Role by ID documentgenerator.role.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Result ObjectResult Object

Role ObjectRole Object

Permissions ObjectPermissions Object

Settings ObjectSettings Object

Templates ObjectTemplates Object

Documents ObjectDocuments Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

Code Examples

Response Handling

Returned Data

Result Object

Role Object

Permissions Object

Settings Object

Templates Object

Documents Object

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning