PersonService (CommonRestServices API)

java.lang.Object
- kz.arta.synergy.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

Constructors
Constructor and Description

PersonService()

Constructors
Constructor and Description
`PersonService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Response`	`checkExtModuleUserRights(java.lang.String moduleCode)` API проверки прав на внешний модуль Проверяет, есть ли у авторизованного пользователя права на модуль URL rest/api/person/check_ext_module Method GET
`Response`	`deleteUserAuthKey(java.lang.String moduleID)` удаляет ключ авторизации пользователя вне сессии URL rest/api/person/invalidate_auth_key Method GET
`java.lang.String`	`deleteUserPhoto(java.lang.String userID, java.lang.String locale)` Метод удаляет фотографию пользователя URL /rest/api/person/photo/delete Method GET
`java.lang.String`	`generateUserAuthToken(java.lang.String moduleID)` генерирует ключ для авторизации пользователя вне сессии URL rest/api/person/generate_auth_key Method GET
`java.lang.String`	`getAccountFullName(java.lang.String userID)`
`Response`	`getCreateMenuItems()` Возвращает доступные пользователю пункты меню кнопки "Создать".
`java.lang.String`	`getSSOHash(java.lang.String clientParams)` Метод возвращает SSOHash пользователя URL /rest/api/person/SSOHash Method GET
`Response`	`getUser(java.lang.String locale, boolean getGroups)` Авторизует пользователя и возвращает информацию о нем
`Response`	`getUserDepartments(java.lang.String userID, java.lang.String userCode)` Возвращает список из ID и кодов подразделений, к которым принадлежит этот пользователь, начиная с его непосредственного подразделения и вверх до корня URL rest/api/person/get_user_departments Method GET
`Response`	`getUserDepartments(java.lang.String userID, java.lang.String userCode, java.lang.String depID, java.lang.String depCode)`
`java.lang.String`	`getUserID()`
`Response`	`updateUserAuthKey(java.lang.String moduleID)` обновление аренды токена URL rest/api/person/update_auth_key_expire 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 Response getUser(java.lang.String locale,
                        boolean getGroups)
```
    Авторизует пользователя и возвращает информацию о нем
  - generateUserAuthToken
```
public java.lang.String generateUserAuthToken(java.lang.String moduleID)
```
    генерирует ключ для авторизации пользователя вне сессии
    URL rest/api/person/generate_auth_key
    Method GET
    
    Parameters:
    
    moduleID - код модуля
    
    Returns:
    
    json объект с полями:
    errorCode код выполнения: 0- в случае успешного выполнения, иначе - в случае возникновения ошибки
    errorMessage сообщение об ошибке
    key сгенерированный ключ пользователя
  - deleteUserAuthKey
```
public Response deleteUserAuthKey(java.lang.String moduleID)
```
    удаляет ключ авторизации пользователя вне сессии
    URL rest/api/person/invalidate_auth_key
    Method GET
    
    Parameters:
    
    moduleID - код модуля
    
    Returns:
    
    json объект с полями:
    errorCode код выполнения: 0- в случае успешного выполнения, иначе - в случае возникновения ошибки
    errorMessage сообщение об ошибке
  - checkExtModuleUserRights
```
public Response checkExtModuleUserRights(java.lang.String moduleCode)
```
    API проверки прав на внешний модуль Проверяет, есть ли у авторизованного пользователя права на модуль
    URL rest/api/person/check_ext_module
    Method GET
    
    Parameters:
    
    moduleCode - код модуля
    
    Returns:
    
    true - есть права или false - нет прав
    errorCode код выполнения: статус 200 в случае успешного выполнения, иначе - в случае возникновения ошибки
    errorMessage код ошибки и сообщение об ошибке
  - updateUserAuthKey
```
public Response updateUserAuthKey(java.lang.String moduleID)
```
    обновление аренды токена
    URL rest/api/person/update_auth_key_expire
    Method GET
    
    Parameters:
    
    moduleID - код модуля
    
    Returns:
    
    json объект с полями:
    errorCode код выполнения: 0- в случае успешного выполнения, иначе - в случае возникновения ошибки
    errorMessage сообщение об ошибке
  - 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 - локаль пользователя, выполняющего действие
    
    Returns:
    
    json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке/успешном выполнении
  - getSSOHash
```
public java.lang.String getSSOHash(java.lang.String clientParams)
```
    Метод возвращает SSOHash пользователя
    
    URL /rest/api/person/SSOHash
    Method GET
    
    Parameters:
    
    clientParams - параметр, содержащий user-agent и host пользователя
    
    Returns:
    
    json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке/успешном выполнении
  - getAccountFullName
```
public java.lang.String getAccountFullName(java.lang.String userID)
```
  - getUserDepartments
```
public Response getUserDepartments(java.lang.String userID,
                                   java.lang.String userCode)
```
    Возвращает список из ID и кодов подразделений, к которым принадлежит этот пользователь, начиная с его непосредственного подразделения и вверх до корня
    URL rest/api/person/get_user_departments
    Method GET
    
    Parameters:
    
    userID - UUID пользователя
    
    userCode - код пользователя
    
    Returns:
    
    список из ID и кодов подразделений, к которым принадлежит этот пользователь
    
    [
    [
    {
    "id": "59a00c22-b997-4093-a12a-e0d4b309be77",
    "code": "dep4"
    },
    {
    "id": "1",
    "code": "root"
    }
    ],
    [
    {
    "id": "ad565113-8842-4294-a33a-badb3cfed3e6",
    "code": "dep1.1"
    },
    {
    "id": "07f5d8fe-0057-42b8-9a57-f4e8b28cbd9b",
    "code": "dep1"
    },
    {
    "id": "1",
    "code": "root"
    }
    ]
    ]
  - getUserDepartments
```
public Response getUserDepartments(java.lang.String userID,
                                   java.lang.String userCode,
                                   java.lang.String depID,
                                   java.lang.String depCode)
```
    Parameters:
    
    userID - UUID пользователя
    
    userCode - код пользователя
    
    depID - UUID подразделения
    
    depCode - код подразделения
    
    Returns:
    
    true, если пользователь принадлежит указанному подразделению или одному из его родительских, и false в противном случае.
  - getCreateMenuItems
```
public Response getCreateMenuItems()
```
    Возвращает доступные пользователю пункты меню кнопки "Создать". Отбор пунктов зависит от групп, в которых состоит пользователь.
    URL rest/api/person/get_create_menu_items
    Method GET Не принимает параметры - берёт ID текущего (авторизованного)пользователя
    
    Returns:
    
    список из ID и кодов подразделений, к которым принадлежит этот пользователь
    
    [
    {
    "menu_itemID": "UUID пункта меню",
    "registryID": "UUID реестра",
    "title": "Наименование пункта меню",
    "is_bookmark": "добавлять по-умолчанию в избранное",
    "translations": [
    {
    "locale": "c",
    "value": "Тестовая группа",
    "editByUser": true
    },
    {
    "locale": "en",
    "value": "Тестовая группа",
    "editByUser": true
    },
    {
    "locale": "ru",
    "value": "Тестовая группа",
    "editByUser": true
    },
    {
    "locale": "kk",
    "value": "Тестовая группа",
    "editByUser": true
    },
    {
    "locale": "fr",
    "value": "Тестовая группа",
    "editByUser": true
    }
    ],
    "parentID": "UUID родительского объекта",
    "is_group": "является группой или пунктом меню"
    }
    ]
  - getUserID
```
public java.lang.String getUserID()
```

Class PersonService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PersonService

Method Detail

getUser

generateUserAuthToken

deleteUserAuthKey

checkExtModuleUserRights

updateUserAuthKey

deleteUserPhoto

getSSOHash

getAccountFullName

getUserDepartments

getUserDepartments

getCreateMenuItems

getUserID