Просмотров: 4118
Дата последнего изменения: 19.07.2022
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
4
5
Получение данных о подразделении |
Ревизия
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get
: 18 |
Обратите внимание! Метод указан с использованием функции
restCommand - это метод отправки данных в
Битрикс24, данный метод есть в примере
ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод
BX24.callMethod или
bitrix24-php-sdk.
Примечание: Метод
im.department.get доступен только для
интранет-пользователей
В Битрикс24 различают два вида пользователей:
интранет-пользователи – внутренние пользователи (сотрудники Вашей компании);
экстранет-пользователи – внешние пользователи (поставщики, дистрибьюторы и т.п.).
Подробнее о возможностях интранет и экстранет пользователей...
.
Параметры
Параметр |
Пример |
Обязат. |
Описание |
Ревизия |
ID |
[51] |
Да |
Идентификаторы подразделений |
18 |
USER_DATA |
N |
Нет |
Подгружать данные о пользователях |
18 |
|
- Если передан параметр
USER_DATA = Y
, то к результату будут подгружены данные о руководителе.
Вызов метода и ответ
JavaScript
BX24.callMethod('im.department.get', {ID: [51]}, function(result){
if(result.error())
{
console.error(result.error().ex);
}
else
{
console.log(result.data());
}
});
PHP
$result = restCommand('im.department.get', Array(
'ID' => [51],
), $_REQUEST["auth"]);
Пример ответа
{
"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
– выбранный статус пользователя
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
– краткое описание возникшей ошибки
Возможные коды ошибок
Код |
Описание |
INVALID_FORMAT |
Передан некорректный формат идентификаторов |
|