Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Получить информацию о подразделении im.department.get», проанализируем лучшие практики и покажем, как правильно использовать im.department.get в реальных задачах.

Получить информацию о подразделении im.department.get

Тут может не хватать некоторых данных — дополним в ближайшее время

• нужны правки под стандарт написания
• не указаны типы параметров
• отсутствуют примеры

> Scope: im
>
> Кто может выполнять метод: любой пользователь

Метод im.department.get получает данные о подразделении.

• Если передан параметр USER_DATA = Y, то к результату будут подгружены данные о руководителе.

Практические примеры использования в коде

• JS

    try
    {
    	const response = await $b24.callMethod(
    		'im.department.get',
    		{
    			ID: [51]
    		}
    	);
    	
    	const result = response.getData().result;
    	console.log(result);
    }
    catch( error )
    {
    	console.error(error.ex);
    }

• PHP

    try {
        $response = $b24Service
            ->core
            ->call(
                'im.department.get',
                [
                    'ID' => [51]
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        if ($result->error()) {
            echo 'Error: ' . $result->error()->ex;
        } else {
            echo 'Success: ' . print_r($result->data(), true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting department information: ' . $e->getMessage();
    }

• BX24.js

    BX24.callMethod(
        'im.department.get',
        {
            ID: [51]
        },
        function(result){
            if(result.error())
            {
                console.error(result.error().ex);
            }
            else
            {
                console.log(result.data());
            }
        }
    );

• PHP CRest

    $result = restCommand(
        'im.department.get',
        Array(
            'ID' => [51],
        ),
        $_REQUEST[
            "auth"
        ]
    );    

• cURL

// пример для cURL

Ответ в случае успеха

{
    "result": [
        {
            "id": 51,
            "name": "Московский филиал",
            "full_name": "Московский филиал / Битрикс"
            "manager_user_id": 11,
        }
    ]
}    

Описание ключей

• id – идентификатор подразделения
• name – краткое название подразделения
• full_name – полное название подразделения
• manager_user_data – объект описания данных руководителя (не доступно, если USER_DATA != 'Y'):
• id – идентификатор пользователя
• name – имя и фамилия пользователя
• first_name – имя пользователя
• last_name – фамилия пользователя
• work_position – должность
• color – цвет пользователя в формате hex
• avatar – ссылка на аватар (если пусто, значит аватар не задан)
• gender – пол пользователя
• birthday – день рождения пользователя в формате DD-MM, если пусто – не задан
• extranet – признак внешнего экстранет-пользователя (true/false)
• network – признак пользователя Битрикс24.Network (true/false)
• bot – признак бота (true/false)
• connector – признак пользователя открытых линий (true/false)
• external_auth_id – код внешней авторизации
• status – статус пользователя. Всегда отображается как online, даже если пользователь установил статус «Не беспокоить». Статус «Не беспокоить» влияет только на получение уведомлений и не виден другим пользователям
• idle – дата, когда пользователь отошел от компьютера, в формате АТОМ (если не задано, false)
• last_activity_date – дата последнего действия пользователя в формате АТОМ
• mobile_last_date – дата последнего действия в мобильном приложении в формате АТОМ (если не задано, false)
• absent – дата, по какое число у пользователя отпуск, в формате АТОМ (если не задано, false)

Ответ в случае ошибки

{
    "error": "INVALID_FORMAT",
    "error_description": "A wrong format for the ID field is passed"
}

Описание ключей

• error – код возникшей ошибки
• error_description – краткое описание возникшей ошибки

Возможные коды ошибок