kz.arta.synergy.api.rest.filecabinet

Class UsersService

java.lang.Object

kz.arta.synergy.api.rest.filecabinet.UsersService

public class UsersService
extends java.lang.Object

 User: topa
 Date: 03.05.13
 Time: 17:52
 

Since:

2.31

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsersService.ChangeAuthTypes

Constructor Summary

Constructors

Constructor and Description
UsersService()

Method Summary

Modifier and Type	Method and Description
Response	changeCredentials(java.lang.String login, java.lang.String password, java.lang.String passwordConfirm, java.lang.String actionCode, java.lang.String locale) API для изменение логина или пароля текущего пользователя.
java.lang.String	checkExistence(java.lang.String login, java.lang.String code, java.lang.String mail) Метод проверки существования пользователя URL rest/api/filecabinet/user/checkExistence Method GET
java.lang.String	createUser(java.lang.String lastname, java.lang.String firstname, java.lang.String patronymic, java.lang.String pointersCode, boolean isChancellery, boolean isConfigurator, boolean isAdmin, java.lang.String email, java.lang.String jid, java.lang.String privateFolder, boolean hasAccess, boolean hasPrivateFolder, java.util.List<java.lang.String> hrDepartmentID, java.lang.String userID, java.lang.String login, java.lang.String password, java.lang.String locale) Метод создает/изменяет пользователя URL rest/api/filecabinet/user/save Method POST
java.lang.String	deleteUser(java.lang.String userID, java.lang.String locale) Метод удаляет пользователя из системы URL rest/api/filecabinet/user/delete Method GET
Response	getUser(java.lang.String userID, java.lang.String locale, boolean getGroups) Load and return basic iformation on user as json object
Response	getUserContacts(java.lang.String userID, java.lang.String locale) Список контактов пользователя
java.lang.String	getUserID()
static Response	getUserInner(java.lang.String userId, java.lang.String locale, boolean getGroups)
java.lang.String	getUsersByFieldValue(java.lang.String formUUID, java.lang.String formCode, java.lang.String fieldName, java.lang.String value, java.lang.String locale) ВНИМАНИЕ!

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersService

public UsersService()

Method Detail

getUser

public Response getUser(java.lang.String userID,
                        java.lang.String locale,
                        boolean getGroups)

Load and return basic iformation on user as json object

getUserInner

public static Response getUserInner(java.lang.String userId,
                                    java.lang.String locale,
                                    boolean getGroups)

getUserContacts

public Response getUserContacts(java.lang.String userID,
                                java.lang.String locale)

Список контактов пользователя

Parameters:

userID - uuid пользователя

locale - локаль

Returns:

createUser

public java.lang.String createUser(java.lang.String lastname,
                                   java.lang.String firstname,
                                   java.lang.String patronymic,
                                   java.lang.String pointersCode,
                                   boolean isChancellery,
                                   boolean isConfigurator,
                                   boolean isAdmin,
                                   java.lang.String email,
                                   java.lang.String jid,
                                   java.lang.String privateFolder,
                                   boolean hasAccess,
                                   boolean hasPrivateFolder,
                                   java.util.List<java.lang.String> hrDepartmentID,
                                   java.lang.String userID,
                                   java.lang.String login,
                                   java.lang.String password,
                                   java.lang.String locale)

Метод создает/изменяет пользователя

URL rest/api/filecabinet/user/save
Method POST

Parameters:

lastname - фамилия, FormParam

firstname - имя, FormParam

patronymic - отчество, FormParam

pointersCode - код показателя, FormParam

isChancellery - является ли сотрудником канцелярии, FormParam

isConfigurator - является ли методологом, FormParam

isAdmin - является ли администратором системы, FormParam

email - почтовый адрес для уведомлений, FormParam

jid - адрес jabber аккаунта, FormParam

privateFolder - личная папка, FormParam

hasAccess - имеет ли доступ в систему, FormParam

hrDepartmentID - UUID подразделений, в которых является сотрудником ОКК, FormParam

userID - идентификатор пользователя. Необходимо передавать если должно выполниться изменение существующего пользователя

hasPrivateFolder - создавать ли личную папку пользователя. Имеет смысл только при создании пользователя

locale - локаль пользователя, QueryParam

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке. В случае успешного выполнения так же возвращается userID идентификатор созданного/измененного пользователя

changeCredentials

public Response changeCredentials(java.lang.String login,
                                  java.lang.String password,
                                  java.lang.String passwordConfirm,
                                  java.lang.String actionCode,
                                  java.lang.String locale)

API для изменение логина или пароля текущего пользователя.

URL rest/api/filecabinet/user/changeCredentials
Method POST

Parameters:

login - новый логин, x-www-form-urlencoded

password - новый пароль, x-www-form-urlencoded

passwordConfirm - подтвержение нового пароля, x-www-form-urlencoded

actionCode - тип дейтсвия. CHANGE_ALL - смена логина и пароля, CHANGE_LOGIN - смена логина, CHANGE_PASSWORD - смена пароля. x-www-form-urlencoded

locale - локаль, x-www-form-urlencoded

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке.

deleteUser

public java.lang.String deleteUser(java.lang.String userID,
                                   java.lang.String locale)

Метод удаляет пользователя из системы

URL rest/api/filecabinet/user/delete
Method GET

Parameters:

userID - UUID пользователя, которого надо удалить (QueryParam)

locale - локаль пользователя, выполняющего действие (QueryParam)

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке.

checkExistence

public java.lang.String checkExistence(java.lang.String login,
                                       java.lang.String code,
                                       java.lang.String mail)

Метод проверки существования пользователя

URL rest/api/filecabinet/user/checkExistence
Method GET

Parameters:

login - логин пользователя (QueryParam)

code - код пользователя (QueryParam)

mail - код пользователя (QueryParam)

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке. (при ошибке) result - true/false (при успешнов выполнении)

getUsersByFieldValue

public java.lang.String getUsersByFieldValue(java.lang.String formUUID,
                                             java.lang.String formCode,
                                             java.lang.String fieldName,
                                             java.lang.String value,
                                             java.lang.String locale)

ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный

Находит пользователей по значению поля дополнительной карточки и возвращает список их идентификаторов

URL rest/api/filecabinet/get_by_field_value
Method GET

Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации пользователей ARTA Synergy с пользователями сторонней системы). В дополнительной карточке пользователя может храниться идентификатор соответствующего пользователя в сторонней системе (или иное поле, присутствующее в обоих системах и позволяющее установить соответствие между пользователями, например, ИИН) этот метод позволит найти идентификатор пользователя в нашей системе по его идентификатору из сторонней системы

Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).

Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.

Parameters:

formUUID - uuid формы, по полю которой необходимо произвести поиск

formCode - uuid формы, по полю которой необходимо произвести поиск

fieldName - название поля, по которому необходимо произвести поиск

value - значение поля

locale - локаль пользователя

Returns:

список, состоящий из идентификаторов пользователей

getUserID

public java.lang.String getUserID()