gamification.user.search
Scope:
gamificationКто может вызывать: Только admin или manager. Подробнее: Права доступа
Запустить фоновый поиск пользователей. Операция асинхронная: после вызова используйте user.searchStatus для опроса и user.searchResult для получения результата.
HTTP: POST
Побочные эффекты: инициирует фоновое задание поиска.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
format |
string |
да | Формат строк в content. Допустимые значения: email, fn-ln, ln-fn, ln-fn-sn, fn-sn-ln |
content |
string |
да | Список значений для поиска (по одной записи на строку) |
Значения format
| Значение | Описание |
|---|---|
email |
Email пользователя |
fn-ln |
Имя Фамилия |
ln-fn |
Фамилия Имя |
ln-fn-sn |
Фамилия Имя Отчество |
fn-sn-ln |
Имя Отчество Фамилия |
Возвращаемые данные
result.result — объект с идентификатором запущенного задания.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Вызывающий не является admin/manager |
VALIDATION_ERROR |
Не передан format или content, либо неизвестное значение format |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.user.search.json" \
-H "Content-Type: application/json" \
-d '{"format": "ln-fn", "content": "Иванов Иван"}'
Предыдущая
Следующая