IPR SMART API / Документация о сервисе
В данном разделе приведен основной перечень запросов IPR SMART API.
Управление пользователями
/2.0/security/users
Получение текущего списка пользователей
{ "success": true, "message": "", "total": 8289, "status": 200, "data": [ { "id": 6463, "username": "**************", "fullname": "**************", "email": "**************", "blocked": 0, "user_type": 3, "registration_date": "30.09.2012", "blockedafter": "17.08.2018" },...
В запрос Вы можете включать дополнительно параметры фильтрации каталога:
- email - фильтрация по email-адресу
- username — по логину пользователя
- fullname — по полному имени пользователя
/2.0/security/users/get/{id}
Запрос возвращает подробную информацию о пользователе организации.
{ "success": true, "message": "", "status": 200, "data": { "id": 6463, "username": "**************", "fullname": "**************", "email": "**************", "blocked": 0, "user_type": 3, "class": 0, "specialty": "", "group": "", "facultet": "", "department": "уголовно-правовых дисциплин", "registration_date": "30.09.2012", "blockedafter": "17.08.2018" } }
/2.0/security/users/add
Запрос на добавление пользователя. Обязательно должны быть переданы следующие данные:
- email — email-адрес пользователя, длина не более 255 символов
- fullname — полное имя пользователя
- password — пароль пользователя
Опционально:
- user_type — тип пользователя: значение от 1 до 4, где
- 1 — студент
- 2 — аспирант
- 3 — преподаватель
- 4 — отсутствует определение типа пользователя
Формат ответа в случае успеха:
{ "success": true, "message": "", "status": 200, "data": { "id": 949420, "username": "**************", "email": "**************", "fullname": "**************", "blocked": 0, "blockedafter": 0, "user_type": 4 } }
Пример сообщения об ошибке при добавлении пользователя:
{ "success": false, "message": "Пользователь с таким email-адресом уже зарегистрирован в IPR SMART", "status": 409, "data": null, "errors": [] }
Пример сообщения при ошибке валидирования данных:
{ "success": false, "message": "В форме запроса обнаружены ошибки", "status": 400, "data": null, "errors": { "email": [ "The email must be a valid email address." ] } }
/2.0/security/users/delete/{id}
Запрос на блокировку пользователя организации.
{ "success": true, "message": "Пользователь успешно заблокирован", "status": 200, "data": null }
/2.0/security/users/restore/{id}
Запрос на восстановление учетной записи пользователя.
{ "success": true, "message": "Пользователь успешно восстановлен", "status": 200, "data": null }