77  /  108

im.search.user.list

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

Поиск пользователей

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

Параметры

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

Вызов метода

JavaScript

BX24.callMethod('im.search.user.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.user.list', Array(
	'FIND' => 'Евгений'
), $_REQUEST["auth"]);	

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

{    
	"result": {
		1: {
			"id": 1,
			"name": "Евгений Шеленков",
			"first_name": "Евгений",
			"last_name": "Шеленков",
			"work_position": "",
			"color": "#df532d",
			"avatar": "http://192.168.2.232/upload/resize_cache/main/1d3/100_100_2/shelenkov.png",
			"gender": "M",
			"birthday": "",
			"extranet": false,
			"network": false,
			"bot": false,
			"connector": false,
			"external_auth_id": "default",
			"status": "online",
			"idle": false,
			"last_activity_date": "2018-01-29T17:35:31+03:00",
			"desktop_last_date": false,
			"mobile_last_date": false,
			"departments": [
			  50
			],
			"absent": false
		}
	},
	"total": 1
}      

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

  • id – идентификатор пользователя
  • name – имя и фамилия пользователя
  • first_name – имя пользователя
  • last_name – фамилия пользователя
  • work_position – должность
  • color – цвет пользователя в формате hex
  • avatar – ссылка на аватар (если пусто, значит аватар не задан)
  • avatar_hr – ссылка на аватар в высоком разрешении (доступен только при запросе с параметром AVATAR_HR = 'Y')
  • 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)
  • desktop_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С-Битрикс»