kz.arta.synergy.api.rest.userchooser

Class UserChooserService

java.lang.Object

kz.arta.synergy.api.rest.userchooser.UserChooserService

public class UserChooserService
extends java.lang.Object

Created with IntelliJ IDEA. User: topa Date: 30.06.13 Time: 21:49 To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
UserChooserService()

Method Summary

Modifier and Type	Method and Description
Response	addOftenChosenUsers(java.util.List<java.lang.String> users) метод сохраняет последних выбранных пользователей для пользователя url: /rest/api/userchooser/addOftenUsers method: GET Parameters: userID - идентификатор пользователя (может повторяться) Возвращает json c полями errorCode, errorMessage, где - errorCode код ошибки (0, если ошибки нет) - errorMessage расшифровка ошибки (пустая строка, если ошибки нет) если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
Response	checkDepartments(int pageNumber, int countInPart, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterChildDepartmentID, java.lang.String filterPositionID, java.lang.String search, boolean showChildDepartments, java.lang.String filterHrUser, java.util.List<java.lang.String> valuesToCheck, java.lang.String filterUserID, java.lang.String locale) проверка подходят ли переданные департаменты под указанные параметры поиска url: /rest/api/userchooser/checkDepartments method : GET startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска customFields не используется filterDepartmentID идентификатор непосредственного родительского подразделения filterChildDepartmentID идентификатор непосредственного родительского подразделения filterPositionID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать valuesToCheck проверяемые значения идентификаторов передается как valuesToCheck=identifier1&valuesToCheck=identifier2
Response	checkPositions(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.Integer operationType, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.util.List<java.lang.String> valuesToCheck) проверка подходят ли переданные должности под переданные параметры выборки
Response	checkUsers(java.lang.String locale, boolean showAll, int levelsCount, int groupID, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String departmentID, java.lang.String userID, java.lang.String showNoPosition, java.lang.String filterPositionID, java.lang.String filterDepartmentID, java.lang.String positionType, java.util.List<java.lang.String> usersToCheck) проверка подходят ли данные пользователи под указанные параметры url: /rest/api/userchooser/search_ext method : GET locale локаль пользователя showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя groupID идентификатор группы.
Response	getAllPositions(int startRecord, int recordsCount, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID) получение списка должностей url: /rest/api/userchooser/search_all_positions method : GET startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска showOnlyVacant - false по умолчанию, отображать только вакантные должности actorID пользователь от имени которого выполнять поиск filterDepartmentID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать
Response	getDepartments(int pageNumber, int countInPart, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterChildDepartmentID, java.lang.String filterPositionID, java.lang.String search, boolean showChildDepartments, java.lang.String filterHrUser, java.lang.String filterUserID, java.lang.String locale) получение списка департаментов url: /rest/api/userchooser/search_dept method : GET Параметры: locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть filterDepartmentID идентификатор непосредственного родительского подразделения filterChildDepartmentID идентификатор непосредственного родительского подразделения filterPositionID идентификатор непосредственного родительского подразделения search параметр текстового поиска Описание ответа: массив найденных должностей поля возвращаемой сущности departmentId -идентификатор департамента departmentName наименование hasChildren имеются ли дочерние подразделения parentName наименование родительского департамента если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
Response	getDepartments(java.util.List<java.lang.String> departmentIDs, java.lang.String locale) получение информации о должностях url: /rest/api/userchooser/getUserInfo method : GET
Response	getOftenChosenUsers(int startRecord, int recordsCount, java.lang.String locale, boolean showAll, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String filterPositionID, java.lang.String filterDepartmentID, java.lang.Integer positionType, java.util.List<java.lang.String> customFields, java.lang.String userNameDisplayType) получение списка часто выбираемых пользователей пользователей url: /rest/api/userchooser/getOftenChosenUsers method : GET startRecord C какой записи поднимать пользователей recordsCount Какое кол-во записей поднимать locale локаль пользователя showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи search Строка поиска operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени actorID, но и от имени тех пользователей, которые делегировали ему право на operationType ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали actorID право на ownerOperationType и самим actorID filterPositionID UUID должности - фильтра.
Response	getOftenPositions(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.Integer operationType, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.util.List<java.lang.String> customFields) получение списка часто выбираемых должностей url: /rest/api/userchooser/getOftenChosenPositions method : GET startRecord - по умолчанию 0 recordsCount - по умолчанию 30 showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности) showOnlyVacant - false по умолчанию, отображать только вакантные должности locale - локаль userID пользователь от имени которого выполнять поиск operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности) search параметр текстового поиска departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть filterDepartmentID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать customField не используется
Response	getPositions(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.Integer operationType, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.util.List<java.lang.String> customFields) получение списка должностей url: /rest/api/userchooser/search_pos startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности) showOnlyVacant - false по умолчанию, отображать только вакантные должности operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности) mode - по умолчанию 0(COMMON_MODE).
Response	getPositions(java.util.List<java.lang.String> positionIDs, java.lang.String locale) получение информации о должностях url: /rest/api/userchooser/getUserInfo method : GET
Response	getUserCalendarStatus(java.lang.String userID, java.lang.String date, java.lang.String locale) url: /rest/api/userchooser/getUserCalendarStatus method : GET userID идентификатор пользователя чьи статусы нам необходимо получить date дата в формате yyy-MM-dd locale локаль Пример запроса: `rest/api/userchooser/getUserCalendarStatus?
java.lang.String	getUserID()
java.lang.String	getUsers(int startRecord, int recordsCount, java.lang.String locale, boolean showAll, int levelsCount, int groupID, java.lang.String groupCode, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String departmentID, java.lang.String userID) Метод выполняет поиск пользователей URL rest/api/userchooser/search Method GET Для каждого пользователя возвращаются следующие данные userID - идентификатор пользователя name - имя пользователя в формате Фамилия И.О.
Response	getUsers(java.util.List<java.lang.String> userIDs, java.lang.String locale) получение информации о пользователях (группах, контактах) url: /rest/api/userchooser/getUserInfo method : GET Описание ответа: массив объектов с информацией о пользователях departmentName наименование департамента firstname имя lastname фамилия patronymic отчество personID идентификатор пользователя personName имя пользователя positionName наименование должности customFields - свойства элемента, зависят от типа элемента (смотрите пункт про определение типа сущности по идентификатору) Определение типа сущности по идентификатору и доп поля этой сущности если userID начинается "g-" - группа (type - groupId, id - идентификатор группы, code - код группы) "contact-" - контакт (contactType - организация или человек, email - почта если есть, id - идентификатор контакта, type - contact, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса) "text-" - текст (type - text, text - true, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса) иначе пользователь( type - person, id идентификатор пользователя, calendarType - тип календарного статуса, calendarStatus - статус, calendarColor - цвет статуса, calendarTitle - название статуса, calendarStatusLabel - подпись в чузере статуса, calendarStartDate - дата начала, calendarFinishDate - дата завершения если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
Response	getUsersCalendarStatus(java.util.List<java.lang.String> users, java.lang.String date, java.lang.String locale) url: /rest/api/userchooser/getUsersCalendarStatus method : GET Пример ответа: { "4bd1ef2e-3271-4dd3-ac67-9a8017abe1f4": { "type": 1, "status": "free", "color": "#fecebe", "title": "ОТПУСК!!!"
Response	getUsersExt(int startRecord, int recordsCount, java.lang.String locale, boolean showAll, int levelsCount, int groupID, java.lang.String groupCode, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String departmentID, java.lang.String userID, java.lang.String showNoPosition, java.lang.String filterPositionID, java.lang.String filterDepartmentID, java.lang.String positionType, java.util.List<java.lang.String> customFields, java.lang.String userNameDisplayType, boolean showEmailContacts, boolean showGroups) получение списка пользователей url: /rest/api/userchooser/search_ext method : GET startRecord C какой записи поднимать пользователей recordsCount Какое кол-во записей поднимать locale локаль пользователя showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя groupID идентификатор группы.
Response	getUserStatusInPeriod(java.lang.String start, java.lang.String finish, java.lang.String type, java.lang.String locale, int startRecord, int recordsCount, java.lang.String sortByDate) Апи получения пользователей с назначенным календарем Метод возвращает список пользователей, назначенный период которых полностью или частично попадает в указанный промежуток времени.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserChooserService

public UserChooserService()

Method Detail

getUsers

public java.lang.String getUsers(int startRecord,
                                 int recordsCount,
                                 java.lang.String locale,
                                 boolean showAll,
                                 int levelsCount,
                                 int groupID,
                                 java.lang.String groupCode,
                                 java.lang.String search,
                                 java.lang.Integer operationType,
                                 java.lang.Integer ownerOperationType,
                                 java.lang.String departmentID,
                                 java.lang.String userID)

Метод выполняет поиск пользователей

URL rest/api/userchooser/search
Method GET

Для каждого пользователя возвращаются следующие данные
userID - идентификатор пользователя
name - имя пользователя в формате Фамилия И.О.
position - название должности

Примеры:
Получение списка подчиненных пользователей

rest/api/userchooser/search?showAll=false

Получение списка всех пользователей (подчиненных и не подчиненных)

rest/api/userchooser/search?showAll=true

Получение списка всех пользователей, подчиненных user1

rest/api/userchooser/search?showAll=true&userID=user1

Получение списка всех пользователей (подчиненных и не подчиненных) в имени/фамилии которых содержится строка "абв"

rest/api/userchooser/search?showAll=true&search=абв

Получение списка всех пользователей (подчиненных и не подчиненных) в имени/фамилии которых содержится строка "абв" из департамента с идентификатором department1

rest/api/userchooser/search?showAll=true&search=абв&departmentID=department1

Получение списка всех пользователей, которым есть право ставить работу

rest/api/userchooser/search?showAll=false&operationType=101

Получение списка всех пользователей, которые делегировали право на создание работы

rest/api/userchooser/search?showAll=true&ownerOperationType=101

startRecord первая запись списка
recordsCount количество записей в списке
locale локаль пользователя
showAll true - показывать всех пользователей, иначе - только подчиненных
search строка поиска, вырождается в условие "содержит ли имя или фамилия пользователя эту строку".
operationType идентификатор действия. Нужно использовать, если для получения списка пользователей необходимо учесть делегированные права на это действие. Например, для получения списка пользователей, которым можно ставить работу
ownerOperationType - идентификатор действия для получения списка пользователей, которые делегировали данное действие текущему пользователю. Например, для получения списка пользователей, от имени которых можно создавать работы
departmentID идентификатор департамента внутри которого необходимо осуществить поиск. По-умолчанию null - это означает, что поиск осуществляется по всей орг. структуре
groupID id группы пользователя
groupCode код группы пользователя
levelsCount параметр для будущего использования

Returns:

список пользователей как список json

getUsersExt

public Response getUsersExt(int startRecord,
                            int recordsCount,
                            java.lang.String locale,
                            boolean showAll,
                            int levelsCount,
                            int groupID,
                            java.lang.String groupCode,
                            java.lang.String search,
                            java.lang.Integer operationType,
                            java.lang.Integer ownerOperationType,
                            java.lang.String departmentID,
                            java.lang.String userID,
                            java.lang.String showNoPosition,
                            java.lang.String filterPositionID,
                            java.lang.String filterDepartmentID,
                            java.lang.String positionType,
                            java.util.List<java.lang.String> customFields,
                            java.lang.String userNameDisplayType,
                            boolean showEmailContacts,
                            boolean showGroups)

получение списка пользователей
url: /rest/api/userchooser/search_ext
method : GET
startRecord C какой записи поднимать пользователей
recordsCount Какое кол-во записей поднимать
locale локаль пользователя
showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи
levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя
groupID идентификатор группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
groupCode код группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
search Строка поиска
operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени userID, но и от имени тех пользователей, которые делегировали ему право на operationType
ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали userID право на ownerOperationType и самим userID
departmentID Идентификатор подразделения. Если он задан должен отображаться список пользователей только этого подразделения
userID Идентификатор пользователя от имени которого выполняется поиск пользователей
showNoPosition Отображать пользователей, не назначенных на должность
filterPositionID UUID должности - фильтра. В чузере отображаются только пользователи, занимающие данную должность
filterDepartmentID UUID подразделения - фильра. В чузере отображаются только пользователи, занимающие должность в данном подразделении (рекурсивно)
positionType Тип должности Если данный параметр задан, то в чузере отображаются только те пользователи, которые относятся к подразделению, в котором userID занимает должность с типом positionType

customFields перечень дополнительных полей, которые можно подгрузить для данного пользователя (передаются параметрами с названием customField=) может принимать одно значение is_inferior
userNameDisplayType тип отображения имени пользователя (full, short)
showEmailContacts подтягивать контакты
showGroups подтягивать группы о_О

Returns:

список пользователей с полями
personName имя (полное в формате)
personID идентификатор
departmentName наименование департамента
positionName должность
customFields доп поля (которые запрашивались)
lastname фамилия
firstname имя
patronymic отчество

getUsers

public Response getUsers(java.util.List<java.lang.String> userIDs,
                         java.lang.String locale)

получение информации о пользователях (группах, контактах)
url: /rest/api/userchooser/getUserInfo
method : GET Описание ответа: массив объектов с информацией о пользователях
departmentName наименование департамента
firstname имя
lastname фамилия
patronymic отчество
personID идентификатор пользователя
personName имя пользователя
positionName наименование должности
customFields - свойства элемента, зависят от типа элемента (смотрите пункт про определение типа сущности по идентификатору)

Определение типа сущности по идентификатору и доп поля этой сущности
если userID начинается
"g-" - группа (type - groupId, id - идентификатор группы, code - код группы)
"contact-" - контакт (contactType - организация или человек, email - почта если есть, id - идентификатор контакта, type - contact, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса)
"text-" - текст (type - text, text - true, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса)
иначе пользователь( type - person, id идентификатор пользователя, calendarType - тип календарного статуса, calendarStatus - статус, calendarColor - цвет статуса, calendarTitle - название статуса, calendarStatusLabel - подпись в чузере статуса, calendarStartDate - дата начала, calendarFinishDate - дата завершения

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

Parameters:

userIDs - идентификаторы пользователей передаются как userID=identifier1&userID=identifier2&userID=identifier3 (смотрите пункт про определение типа сущности по идентификатору)

locale - локаль

getPositions

public Response getPositions(java.util.List<java.lang.String> positionIDs,
                             java.lang.String locale)

получение информации о должностях
url: /rest/api/userchooser/getUserInfo
method : GET

Parameters:

positionIDs - идентификаторы должностей передаются как positionID=identifier1&positionID=identifier2&positionID=identifier3

locale -

Returns:

code код
departmentName наименование департамента
elementID идентификатор должности
elementName наименование должности
id идентификатор должности
info наименование департамента
name наименование должности
translation не используется
type не используется

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getDepartments

public Response getDepartments(java.util.List<java.lang.String> departmentIDs,
                               java.lang.String locale)

получение информации о должностях
url: /rest/api/userchooser/getUserInfo
method : GET

Parameters:

departmentIDs - идентификаторы должностей передаются как positionID=identifier1&positionID=identifier2&positionID=identifier3

locale -

Returns:

departmentId - идентификатор департамента
departmentName наименование
parentName наименование родительского департамента
hasChildren - имеет ли департамент дочерние департаменты

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getUsersCalendarStatus

public Response getUsersCalendarStatus(java.util.List<java.lang.String> users,
                                       java.lang.String date,
                                       java.lang.String locale)

url: /rest/api/userchooser/getUsersCalendarStatus
method : GET Пример ответа:

  {
      "4bd1ef2e-3271-4dd3-ac67-9a8017abe1f4": {
          "type": 1,
          "status": "free",
          "color": "#fecebe",
          "title": "ОТПУСК!!!",
          "statusLabel": "отпуск",
          "startDate": 1456423200000,
          "finishDate": 1474480800000
      },
      "1": {
          "type": 1,
         "status": "free",
          "color": "#456789",
          "title": "Командировка",
          "statusLabel": "Командировка",
          "startDate": 1456423200000,
          "finishDate": 1474480800000
      }
  }
 

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

Parameters:

users - несколько пользователей userID=userid1&userID=userid2

date - дата в формате yyy-MM-dd

locale - локаль

getUserCalendarStatus

public Response getUserCalendarStatus(java.lang.String userID,
                                      java.lang.String date,
                                      java.lang.String locale)

url: /rest/api/userchooser/getUserCalendarStatus
method : GET
userID идентификатор пользователя чьи статусы нам необходимо получить
date дата в формате yyy-MM-dd
locale локаль Пример запроса:

`rest/api/userchooser/getUserCalendarStatus?userID=407d94f5-c8dd-469d-8328-ae426f04dbd4`

Пример возвращаемого объекта JSON: [ { "type": 3, "status": "free", "color": "green", "title": "Ежегодный оплачиваемый отпуск", "statusLabel": "В отпуске с 28.12.16 по 04.01.17", "startDate": "2016-12-28", "finishDate": "2017-01-04", "makeVacant": 0 }, { "type": 3, "status": "free", "color": "green", "title": "Ежегодный оплачиваемый отпуск", "statusLabel": "В отпуске с 26.12.16 по 29.12.16", "startDate": "2016-12-26", "finishDate": "2016-12-29", "makeVacant": 0 } ]

getUserStatusInPeriod

public Response getUserStatusInPeriod(java.lang.String start,
                                      java.lang.String finish,
                                      java.lang.String type,
                                      java.lang.String locale,
                                      int startRecord,
                                      int recordsCount,
                                      java.lang.String sortByDate)

Апи получения пользователей с назначенным календарем

Метод возвращает список пользователей, назначенный период которых полностью или
частично попадает в указанный промежуток времени.
URL метода: /rest/api/userchooser/getUserStatusInPeriod
method : GET

Parameters:

start - дата начала периода, в формате `YYYY-MM-DD` (обяз.)

finish - дата завершения периода, в формате `YYYY-MM-DD` (обяз.);

type - тип назначенного статуса, соответствует полю type справочника "Назначение календаря" c кодом calendar_types (необяз.). Если задан данный параметр, то возвращаются пользователи, тип периода которых соответствует указанному значению, может принимать только целые положительные значения;

locale - локаль;

startRecord - номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)

recordsCount - количество результатов, которое необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100

sortByDate - направление сортировки результатов по выходному параметру дате начала периода start. Тип сортировки - дата. Принимает следующие значения (необяз.):

• asc - записи отсортируются по возрастанию;
• desc- записи отсортируются по убыванию.

По умолчанию параметр принимает значение asc, любое другое значение,
несоответствующее ни одному из возможных значений, будет интерпретировано
как asc.

Returns:

В случае успешного выполнения метод возвращает массив объектов JSON, состоящий из следующих полей:

• userID - идентификатор пользователя;
• start - дата начала периода;
• finish - дата завершения периода;
• type - тип статуса;
• title - название статуса;
• statusLabel - название текущего статуса сотрудника;
• color - цвет статуса;
• busyStatus - тип занятости в данный период. Принимает следующие значения:
• busy - занят в каждый день периода,
• standart - обычное рабочее время,
• free - свободен в каждый день периода.
• makeVacant - признак занятости штатной единицы. Принимает следующие значения:
• 0 - пользователь с таким статусом занимает штатную единицу на период действия статуса;
• 1 - пользователь с таким статусом не занимает штатную единицу на период действия статуса.

Примечание. Пользователь может возвращаться в списке результатов несколько раз, так как пользователю может быть назначено несколько статусов в разные периоды времени.

Для пользователя может быть несколько статусов в течение выбранного периода времени
Пример ответа: ```javascript

[
{
"userID": "8f85e270-ebf1-11e5-835c-525400bb7fc6",
"start": "2016-02-05",
"finish": "2016-02-25",
"calendarType":
{
"type": "0",
"title": "Отпуск",
"statusLabel": "В отпуске с {date.start} по {date.finish}",
"color": "#5462ef",
"busyStatus": "free",
"makeVacant": "0"
}
},
{
"userID": "59377550-ea78-11e5-835c-525400bb7fc6",
"start": "2016-02-15",
"finish": "2017-02-15",
"calendarType":
{
"type": "2",
"title": "Декретный отпуск",
"stateLabel": "В декретном отпуске с {date.start} по {date.finish}",
"color": "#5462ef",
"busyStatus": "free",
"makeVacant": "1"
}
},
{
"userID": "8f85e270-ebf1-11e5-835c-525400bb7fc6",
"start": "2016-02-28",
"finish": "2016-03-05",
"calendarType":
{
"type": "1",
"title": "Командировка",
"statusLabel": "В командировке с {date.start} по {date.finish}",
"color": "#5462ef",
"busyStatus": "busy",
"makeVacant": "0"
}
},
{
"userID": "08c164b0-e775-11e5-835c-525400bb7fc6",
"start": "2016-03-17",
"finish": "2016-03-23",v "calendarType":
{
"type": "1",
"title": "Командировка",
"stateLabel": "В командировке с {date.start} по {date.finish}",
"color": "#5462ef",
"busyStatus": "busy",
"makeVacant": "0"
}
}
]

В случае передачи неверных параметров или внутренней ошибки сервера будет
возвращен массив следующего содержания (сообщение об ошибке будет менятся):

 {

 "errorCode": 13,

 "errorMessage": "Передан некорректный параметр start"

 }

 

Код ответа для внутренней ошибки - HTTP 500(INTERNAL_SERVER_ERROR), для неверных параметров - HTTP 400(BAD_REQUEST)

checkUsers

public Response checkUsers(java.lang.String locale,
                           boolean showAll,
                           int levelsCount,
                           int groupID,
                           java.lang.String search,
                           java.lang.Integer operationType,
                           java.lang.Integer ownerOperationType,
                           java.lang.String departmentID,
                           java.lang.String userID,
                           java.lang.String showNoPosition,
                           java.lang.String filterPositionID,
                           java.lang.String filterDepartmentID,
                           java.lang.String positionType,
                           java.util.List<java.lang.String> usersToCheck)

проверка подходят ли данные пользователи под указанные параметры
url: /rest/api/userchooser/search_ext
method : GET
locale локаль пользователя
showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи
levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя
groupID идентификатор группы. Если параметр задан в чузер подтягиваются пользователи, входящие в данную группу
search Строка поиска
operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени userID, но и от имени тех пользователей, которые делегировали ему право на operationType
ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали userID право на ownerOperationType и самим userID
departmentID Идентификатор подразделения. Если он задан должен отображаться список пользователей только этого подразделения
userID Идентификатор пользователя от имени которого выполняется поиск пользователей
showNoPosition Отображать пользователей, не назначенных на должность
filterPositionID UUID должности - фильтра. В чузере отображаются только пользователи, занимающие данную должность
filterDepartmentID UUID подразделения - фильра. В чузере отображаются только пользователи, занимающие должность в данном подразделении (рекурсивно)
userToCheck Список идентификаторов пользователей. Это поле используется если задан один из параметров фильтра (должность или подразделение)
positionType Тип должности
customFields перечень дополнительных полей, которые можно подгрузить для данного пользователя (передаются параметрами с названием customField=) может принимать одно значение is_inferior
userNameDisplayType тип отображения имени пользователя (full, short)

Returns:

возвращается первый подходящий по параметры поиска пользователь среди переданных, если таковых нет, то возвращается первый из выборки
personName имя (полное в формате)
personID идентификатор
departmentName наименование департамента
positionName должность
customFields доп поля (которые запрашивались)
lastname фамилия
firstname имя
patronymic отчество

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

checkPositions

public Response checkPositions(int startRecord,
                               int recordsCount,
                               boolean showAll,
                               boolean showOnlyVacant,
                               java.lang.String locale,
                               java.lang.String userID,
                               java.lang.Integer operationType,
                               java.lang.String search,
                               java.lang.String departmentID,
                               java.lang.String filterDepartmentID,
                               java.lang.String filterUserID,
                               java.util.List<java.lang.String> valuesToCheck)

проверка подходят ли переданные должности под переданные параметры выборки

Parameters:

startRecord - первая позиция выборки (по умолчанию 0)

recordsCount - количество в выборке (по умолчанию 30)

showAll - показывать все должности, по умолчанию нет (если нет - то отображаются только подчиненные должности)

showOnlyVacant - отображать только вакантные должности, по умолчанию нет

locale - локаль

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

operationType - - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)

search - текстовый поиск

departmentID - идентификатор департамента, чьи дочерние должности (всю иерархию) необходимо отображать для всей иерархии

filterDepartmentID - идентификатор департамента чьи непосредственные должности нужно отображать

filterUserID - идентификатор пользователя чьи должности необходимо отображать

valuesToCheck - проверяемые значения идентификаторов должностей передается как valuesToCheck=identifier1&valuesToCheck=identifier2

Returns:

возвращается массив, который содержит один элемент: первый подходящий по параметры поиска пользователь среди переданных, если таковых нет, то возвращается первый из выборки поля возвращаемой сущности
code код
departmentName наименование департамента
elementID идентификатор должности
elementName наименование должности
translation не используется
type не используется

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

addOftenChosenUsers

public Response addOftenChosenUsers(java.util.List<java.lang.String> users)

метод сохраняет последних выбранных пользователей для пользователя
url: /rest/api/userchooser/addOftenUsers
method: GET
Parameters:
userID - идентификатор пользователя (может повторяться)

Возвращает json c полями errorCode, errorMessage, где
- errorCode код ошибки (0, если ошибки нет)
- errorMessage расшифровка ошибки (пустая строка, если ошибки нет)

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getOftenChosenUsers

public Response getOftenChosenUsers(int startRecord,
                                    int recordsCount,
                                    java.lang.String locale,
                                    boolean showAll,
                                    java.lang.String search,
                                    java.lang.Integer operationType,
                                    java.lang.Integer ownerOperationType,
                                    java.lang.String filterPositionID,
                                    java.lang.String filterDepartmentID,
                                    java.lang.Integer positionType,
                                    java.util.List<java.lang.String> customFields,
                                    java.lang.String userNameDisplayType)

получение списка часто выбираемых пользователей пользователей url: /rest/api/userchooser/getOftenChosenUsers method : GET
startRecord C какой записи поднимать пользователей
recordsCount Какое кол-во записей поднимать
locale локаль пользователя
showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи
search Строка поиска
operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени actorID, но и от имени тех пользователей, которые делегировали ему право на operationType
ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали actorID право на ownerOperationType и самим actorID
filterPositionID UUID должности - фильтра. В чузере отображаются только пользователи, занимающие данную должность
filterDepartmentID UUID подразделения - фильра. В чузере отображаются только пользователи, занимающие должность в данном подразделении (рекурсивно)
positionType Тип должности
customFields перечень дополнительных полей, которые можно подгрузить для данного пользователя (передаются параметрами с названием customField=) может принимать одно значение is_inferior
userNameDisplayType тип отображения имени пользователя (full, short)

Returns:

список пользователей с полями
personName имя (полное в формате)
personID идентификатор
departmentName наименование департамента
positionName должность
customFields доп поля (которые запрашивались)
lastname фамилия
firstname имя
patronymic отчество

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getPositions

public Response getPositions(int startRecord,
                             int recordsCount,
                             boolean showAll,
                             boolean showOnlyVacant,
                             java.lang.String locale,
                             java.lang.String userID,
                             java.lang.Integer operationType,
                             java.lang.String search,
                             java.lang.String departmentID,
                             java.lang.String filterDepartmentID,
                             java.lang.String filterUserID,
                             java.util.List<java.lang.String> customFields)

получение списка должностей url: /rest/api/userchooser/search_pos
startRecord - по умолчанию 0
recordsCount - по умолчанию 30
locale - локаль
departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
search параметр текстового поиска
showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности)
showOnlyVacant - false по умолчанию, отображать только вакантные должности
operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)
mode - по умолчанию 0(COMMON_MODE). Если 1(OFTEN_CHOSEN_MODE)
actorID пользователь от имени которого выполнять поиск
customFields не используется
filterDepartmentID идентификатор непосредственного родительского подразделения
filterUserID идентификатор пользователя чьи должности необходимо показать массив найденных должностей поля возвращаемой сущности
code код
departmentName наименование департамента
elementID идентификатор должности
elementName наименование должности
translation не используется
type не используется
customFields не используется

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getAllPositions

public Response getAllPositions(int startRecord,
                                int recordsCount,
                                boolean showOnlyVacant,
                                java.lang.String locale,
                                java.lang.String userID,
                                java.lang.String search,
                                java.lang.String departmentID,
                                java.lang.String filterDepartmentID,
                                java.lang.String filterUserID)

получение списка должностей url: /rest/api/userchooser/search_all_positions method : GET
startRecord - по умолчанию 0
recordsCount - по умолчанию 30
locale - локаль
departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
search параметр текстового поиска
showOnlyVacant - false по умолчанию, отображать только вакантные должности
actorID пользователь от имени которого выполнять поиск
filterDepartmentID идентификатор непосредственного родительского подразделения
filterUserID идентификатор пользователя чьи должности необходимо показать

Returns:

массив найденных должностей поля возвращаемой сущности
code код
departmentName наименование департамента
elementID идентификатор должности
elementName наименование должности
translation не используется
type не используется
customFields не используется

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getOftenPositions

public Response getOftenPositions(int startRecord,
                                  int recordsCount,
                                  boolean showAll,
                                  boolean showOnlyVacant,
                                  java.lang.String locale,
                                  java.lang.String userID,
                                  java.lang.Integer operationType,
                                  java.lang.String search,
                                  java.lang.String departmentID,
                                  java.lang.String filterDepartmentID,
                                  java.lang.String filterUserID,
                                  java.util.List<java.lang.String> customFields)

получение списка часто выбираемых должностей
url: /rest/api/userchooser/getOftenChosenPositions
method : GET
startRecord - по умолчанию 0
recordsCount - по умолчанию 30
showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности)
showOnlyVacant - false по умолчанию, отображать только вакантные должности
locale - локаль
userID пользователь от имени которого выполнять поиск
operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности)
search параметр текстового поиска
departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
filterDepartmentID идентификатор непосредственного родительского подразделения
filterUserID идентификатор пользователя чьи должности необходимо показать
customField не используется

Returns:

массив найденных должностей поля возвращаемой сущности
code код
departmentName наименование департамента
elementID идентификатор должности
elementName наименование должности
translation не используется
type не используется

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getDepartments

public Response getDepartments(int pageNumber,
                               int countInPart,
                               java.lang.String departmentID,
                               java.lang.String filterDepartmentID,
                               java.lang.String filterChildDepartmentID,
                               java.lang.String filterPositionID,
                               java.lang.String search,
                               boolean showChildDepartments,
                               java.lang.String filterHrUser,
                               java.lang.String filterUserID,
                               java.lang.String locale)

получение списка департаментов url: /rest/api/userchooser/search_dept method : GET Параметры:
locale - локаль
departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
filterDepartmentID идентификатор непосредственного родительского подразделения
filterChildDepartmentID идентификатор непосредственного родительского подразделения
filterPositionID идентификатор непосредственного родительского подразделения
search параметр текстового поиска
Описание ответа:
массив найденных должностей
поля возвращаемой сущности
departmentId -идентификатор департамента
departmentName наименование
hasChildren имеются ли дочерние подразделения
parentName наименование родительского департамента

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

Parameters:

pageNumber - номер страницы результата (0 по умолчанию)

countInPart - количество департаментов в ответе (30 по умолчанию)

showChildDepartments - показывать ли дочерние подразделения

filterHrUser - Фильтр ограничивает департаменты теми, к которым имеет доступ hr-пользователь

filterUserID - идентификатор пользователя чьи должности необходимо показать

checkDepartments

public Response checkDepartments(int pageNumber,
                                 int countInPart,
                                 java.lang.String departmentID,
                                 java.lang.String filterDepartmentID,
                                 java.lang.String filterChildDepartmentID,
                                 java.lang.String filterPositionID,
                                 java.lang.String search,
                                 boolean showChildDepartments,
                                 java.lang.String filterHrUser,
                                 java.util.List<java.lang.String> valuesToCheck,
                                 java.lang.String filterUserID,
                                 java.lang.String locale)

проверка подходят ли переданные департаменты под указанные параметры поиска url: /rest/api/userchooser/checkDepartments method : GET
startRecord - по умолчанию 0
recordsCount - по умолчанию 30
locale - локаль
departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть
search параметр текстового поиска
customFields не используется
filterDepartmentID идентификатор непосредственного родительского подразделения
filterChildDepartmentID идентификатор непосредственного родительского подразделения
filterPositionID идентификатор непосредственного родительского подразделения
filterUserID идентификатор пользователя чьи должности необходимо показать
valuesToCheck проверяемые значения идентификаторов передается как valuesToCheck=identifier1&valuesToCheck=identifier2

Returns:

массив найденных департаментов поля возвращаемой сущности
departmentId -идентификатор департамента
departmentName наименование
hasChildren имеются ли дочерние подразделения
parentName наименование родительского департамента

если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR

getUserID

public java.lang.String getUserID()