79  /  108

im.search.department.list

Просмотров: 298 (Статистика ведётся с 06.02.2017)
Александр Суворов
Сложность урока:
4 уровень - сложно, требуется сосредоточится, внимание деталям и точному следованию инструкции.
1
2
3
4
5

Поиск подразделений

Ревизия: 19
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get.

Параметры

Параметр Пример Обязат. Описание Ревизия
FIND Московский Да Поисковая фраза 19
USER_DATA N Нет Подгружать данные о пользователях 19
OFFSET 0 Нет Смещение выборки пользователей 19
LIMIT 10 Нет Лимит выборки пользователей 19
  • Если передан параметр USER_DATA = Y, то к результату будут подгружены данные о руководителе.
  • Поиск осуществляется по следующим полям: Полное название подразделения.
  • Метод поддерживает стандартную постраничную навигацию Bitrix24 Rest Api, но в добавок к ней есть возможность построить навигацию с помощью параметров OFFSET и LIMIT.

Вызов метода

JavaScript

BX24.callMethod('im.search.department.list', {
	FIND: 'Московский'
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log('users', result.data());
		console.log('total', result.total());
	}
});

PHP

$result = restCommand('im.search.department.list', Array(
	'FIND' => 'Московский'
), $_REQUEST["auth"]);	

Пример ответа

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

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

  • 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": "FIND_SHORT",
    "error_description": "Too short a search phrase."
}

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

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

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

Код Описание
FIND_SHORT Слишком короткая поисковая фраза, поиск осуществляется от трех символов.

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.



0
Курсы разработаны в компании «1С-Битрикс»