kz.arta.synergy.server.api.rest.person
Class PersonService

java.lang.Object
  kz.arta.synergy.server.api.rest.person.PersonService

public class PersonService
extends java.lang.Object

Created with IntelliJ IDEA. User: topa Date: 6/3/13 Time: 8:11 PM To change this template use File | Settings | File Templates.

Constructor Summary

PersonService()

Method Summary

java.lang.String	deleteUserPhoto(java.lang.String userID, java.lang.String locale) Метод удаляет фотографию пользователя URL /rest/api/person/photo/delete Method GET
java.lang.String	generateUserAuthKey(java.lang.String locale, java.lang.String moduleID) генерирует ключ для авторизации пользователя вне сессии URL rest/api/person/generate_auth_key Method GET
java.lang.String	getUser(java.lang.String locale, boolean getGroups) Авторизует пользователя и возвращает информацию о нем URL rest/api/person/auth Method GET

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonService

public PersonService()

Method Detail

getUser

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

Авторизует пользователя и возвращает информацию о нем

URL rest/api/person/auth
Method GET

Parameters:

locale - локаль пользователя, по-умолчанию ru

getGroups - если данный параметр true, то метод вернет так же список групп в которых состоит авторизованный пользователь

Returns:

Если методу не передано никаих параметров кроме локали, то возвращается только json с информацией о пользователе (PersonWrapper#getJsonObject)
Если параметр getGroups=true, то возвращается объект вида

 
     {
 
        person: {},     //информация о пользователе, см PersonWrapper#getJsonObject
 
        groups:                         //список групп
 
             [
 
             {groupID: "",              //идентификатор группы
 
             name: ""}                  //название группы
 
             , ...]
 
    }
 

See Also:

PersonWrapper.getJsonObject(arta.synergy.web.common.client.data.filecabinet.Person)

generateUserAuthKey

public java.lang.String generateUserAuthKey(java.lang.String locale,
                                            java.lang.String moduleID)

генерирует ключ для авторизации пользователя вне сессии

URL rest/api/person/generate_auth_key
Method GET

Parameters:

locale - локаль пользователя (по-умолчанию ru)

moduleID - идентификатор модуля

Returns:

json объект с полями:
errorCode код выполнения: 0- в случае успешного выпонения, иначе - в случае возниковения ошибки
errorMessage сообщение об ошибке
key сгенерированный ключ пользователя

deleteUserPhoto

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

Метод удаляет фотографию пользователя

URL /rest/api/person/photo/delete
Method GET

Parameters:

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

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

Returns:

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