Employees API

Группа методов для работы с сотрудниками.

Описание методов

Данный блок содержит подробное описание по каждому методу API.

[POST]/api/v1/employees

Создание сотрудника в организации.

Основной сценарий Создать сотрудника в системе.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Тело запроса

Тип запроса: application/json

Параметры запроса на создание сотрудника.

Название	Обязат.	Тип	Описание
surname	Да	string	Фамилия.
name	Да	string	Имя.
patronymic	Нет	string	Отчество.
roleId	Да	string(uuid)	Идентификатор роли.
email	Да	string	Адрес электронной почты.
phone	Да	string	Номер телефона.
position	Да	string	Должность в организации.
departmentInfo	Нет	Одна из: EmployeeDepartmentInfo	Настройки видимости подразделений и сведения о текущем подразделении

Пример модели

{
  "surname": "Константинопольский",
  "name": "Константин",
  "patronymic": "Константинович",
  "roleId": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
  "email": "k.konstantin@test.ru",
  "phone": "+79999999999",
  "position": "Супер-сотрудник",
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

Возможные ответы метода

Код	Тип	Описание
200	string(uuid)	Идентификатор сотрудника внутри системы.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/employees

Возвращает список сотрудников абонента.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
search	Нет	Query	string	Параметры поиска (ФИО).
offset	Нет	Query	integer(int32)	Начальное значение списка.
count	Нет	Query	integer(int32)	Количество выводимых значений (По умолчанию: 15).

Возможные ответы метода

Код	Тип	Описание
200	EmployeeShortInfoResultList	Список сотрудников абонента.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "count": 1,
  "data": [
    {
      "id": "71957841-691e-4436-b695-ee65625ae8d9",
      "abonentId": "8b1ea303-b01c-462f-bfe1-c996fbb33150",
      "userId": "a60f7d80-b9d9-4faa-a2f1-3d697c08d426",
      "status": "Blocked",
      "role": {
        "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "name": "Owner.",
        "displayName": "Владелец.",
        "permissions": [
          "Строка"
        ]
      },
      "position": "Директор",
      "fullName": {
        "surname": "Константинопольский",
        "name": "Константин",
        "patronymic": "Константинович"
      }
    }
  ]
}

[PUT]/api/v1/employees/{employeeId}

Обновление информации о сотруднике в организации.

Основной сценарий Обновить основную информацию по сотруднику.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника организации.

Тело запроса

Тип запроса: application/json

Параметры запроса на обновление информации о сотруднике.

Название	Обязат.	Тип	Описание
fullName	Да	Одна из: PersonFullNameInfo	ФИО сотрудника
contactInfo	Да	Одна из: ContactsInfo	Контактные данные сотрудника
position	Да	string	Должность в организации
roleId	Да	string(uuid)	Идентификатор роли, применяется только если владелец или админ редактирует сотрудника
departmentInfo	Нет	Одна из: EmployeeDepartmentInfo	Настройки видимости подразделений и сведения о текущем подразделении

Пример модели

{
  "fullName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  },
  "contactInfo": {
    "email": "k.konstantin@test.ru",
    "phone": "+79999999999"
  },
  "position": "Супер-сотрудник",
  "roleId": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Данные успешно изменены.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/employees/{employeeId}

Возвращает информацию о сотруднике.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника.

Возможные ответы метода

Код	Тип	Описание
200	EmployeeFullInfo	Информация по сотруднику.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "71957841-691e-4436-b695-ee65625ae8d9",
  "abonentId": "8b1ea303-b01c-462f-bfe1-c996fbb33150",
  "userId": "a60f7d80-b9d9-4faa-a2f1-3d697c08d426",
  "inn": "9624440182",
  "snils": "149-558-345 11",
  "status": "Blocked",
  "role": {
    "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "name": "Owner.",
    "displayName": "Владелец.",
    "permissions": [
      "Строка"
    ]
  },
  "position": "Директор",
  "contactInfo": {
    "email": "test@test.ru",
    "phone": "+70000000000"
  },
  "certificates": [
    {
      "certificateSkid": "d29d6128-2926-43f9-a386-0a9ec0c99ddd",
      "certificateAuthority": "Наименование УЦ",
      "ownerSurname": "Строка",
      "ownerName": "Строка",
      "ownerPatronymic": "Строка",
      "certificateNotAfter": "2022-02-11T13:03:05.670Z",
      "certificateNotBefore": "2022-02-11T13:03:05.670Z",
      "serialNumber": "5446565516848",
      "dssCertificateId": "60706ae1-6d47-48d2-9271-7c576153a265",
      "certificateInn": "963992394113"
    }
  ],
  "warrants": [
    {
      "number": "b46ec17f-649a-4240-80a4-f311939dd18e",
      "isUsed": true,
      "startDate": "2022-02-11T13:03:05.670Z",
      "endDate": "2022-02-11T13:03:05.670Z",
      "status": "Rejected",
      "representative": {
        "inn": "9672152699"
      },
      "principal": {
        "inn": "9681731710",
        "kpp": "Строка",
        "ogrn": "1666454467909",
        "organizationName": "Тестовая организация.",
        "personName": {
          "surname": "Константинопольский",
          "name": "Константин",
          "patronymic": "Константинович"
        }
      },
      "empowerments": [
        {
          "code": "404",
          "description": "Подписывание служебных документов.",
          "contents": "Подписывание служебных документов во внутреннем ДО."
        }
      ]
    }
  ],
  "fullName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  },
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "name": "Бухгалтерия",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

[GET]/api/v1/employees/roles

Возвращает список ролей.

Возможные ответы метода

Код	Тип	Описание
200	Role[array]	Идентификатор сотрудника внутри системы.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[GET]/api/v1/employees/current

Возвращает информацию о текущем сотруднике.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Внутренний идентификатор абонента.

Возможные ответы метода

Код	Тип	Описание
200	EmployeeFullInfo	Информация по сотруднику.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "id": "71957841-691e-4436-b695-ee65625ae8d9",
  "abonentId": "8b1ea303-b01c-462f-bfe1-c996fbb33150",
  "userId": "a60f7d80-b9d9-4faa-a2f1-3d697c08d426",
  "inn": "9624440182",
  "snils": "149-558-345 11",
  "status": "Blocked",
  "role": {
    "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "name": "Owner.",
    "displayName": "Владелец.",
    "permissions": [
      "Строка"
    ]
  },
  "position": "Директор",
  "contactInfo": {
    "email": "test@test.ru",
    "phone": "+70000000000"
  },
  "certificates": [
    {
      "certificateSkid": "d29d6128-2926-43f9-a386-0a9ec0c99ddd",
      "certificateAuthority": "Наименование УЦ",
      "ownerSurname": "Строка",
      "ownerName": "Строка",
      "ownerPatronymic": "Строка",
      "certificateNotAfter": "2022-02-11T13:03:05.670Z",
      "certificateNotBefore": "2022-02-11T13:03:05.670Z",
      "serialNumber": "5446565516848",
      "dssCertificateId": "60706ae1-6d47-48d2-9271-7c576153a265",
      "certificateInn": "963992394113"
    }
  ],
  "warrants": [
    {
      "number": "b46ec17f-649a-4240-80a4-f311939dd18e",
      "isUsed": true,
      "startDate": "2022-02-11T13:03:05.670Z",
      "endDate": "2022-02-11T13:03:05.670Z",
      "status": "Rejected",
      "representative": {
        "inn": "9672152699"
      },
      "principal": {
        "inn": "9681731710",
        "kpp": "Строка",
        "ogrn": "1666454467909",
        "organizationName": "Тестовая организация.",
        "personName": {
          "surname": "Константинопольский",
          "name": "Константин",
          "patronymic": "Константинович"
        }
      },
      "empowerments": [
        {
          "code": "404",
          "description": "Подписывание служебных документов.",
          "contents": "Подписывание служебных документов во внутреннем ДО."
        }
      ]
    }
  ],
  "fullName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  },
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "name": "Бухгалтерия",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

[GET]/api/v1/employees/{employeeId}/warrants

Возвращает список доступных доверенностей сотрудника.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника.

Возможные ответы метода

Код	Тип	Описание
200	AvailableWarrantForEmployee[array]	Список доступных доверенностей.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[PUT]/api/v1/employees/{employeeId}/warrant/{warrantNumber}

Добавляет доверенность к сотруднику.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника.
warrantNumber	Да	Path	string(uuid)	Номер доверенности.

Возможные ответы метода

Код	Тип	Описание
200	AvailableWarrantForEmployee	Сведения о добавленной доверенности.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Пример успешного ответа

{
  "number": "b46ec17f-649a-4240-80a4-f311939dd18e",
  "isUsed": true,
  "startDate": "2022-02-11T13:03:05.670Z",
  "endDate": "2022-02-11T13:03:05.670Z",
  "status": "Rejected",
  "representative": {
    "inn": "9672152699"
  },
  "principal": {
    "inn": "9681731710",
    "kpp": "Строка",
    "ogrn": "1666454467909",
    "organizationName": "Тестовая организация.",
    "personName": {
      "surname": "Константинопольский",
      "name": "Константин",
      "patronymic": "Константинович"
    }
  },
  "empowerments": [
    {
      "code": "404",
      "description": "Подписывание служебных документов.",
      "contents": "Подписывание служебных документов во внутреннем ДО."
    }
  ]
}

[DELETE]/api/v1/employees/{employeeId}/warrant/{warrantNumber}

Удаляет доверенность у сотрудника.

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника.
warrantNumber	Да	Path	string(uuid)	Номер доверенности.

Возможные ответы метода

Код	Тип	Описание
200	string	Доверенность успешно удалена.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[POST]/api/v1/employees/{employeeId}/block

Заблокировать сотрудника

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Идентификатор абонента
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Сотрудник успешно заблокирован.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

[POST]/api/v1/employees/{employeeId}/unblock

Разблокировать сотрудника

Параметры в строке запроса

Название	Обязат.	Место	Тип	Описание
abonentId	Да	Header	string(uuid)	Идентификатор абонента
employeeId	Да	Path	string(uuid)	Идентификатор сотрудника

Возможные ответы метода

Код	Тип	Описание
200	Без данных	Сотрудник успешно разблокирован.
400	Без данных	Переданы некорректные параметры запроса.
401	Без данных	Пользователь не авторизован.
403	Без данных	Отказано в доступе.
500	Без данных	Внутренняя ошибка сервера.

Описание дополнительных моделей

Данный блок содержит описание дополнительных моделей.

AreaOfEmpowerment

Список полномочий доверенности.

Название	Обязат.	Тип	Описание
code	Да	string	Код полномочий.
description	Да	string	Описание области полномочий.
contents	Нет	string	Содержание полномочия.

Пример модели

{
  "code": "404",
  "description": "Подписывание служебных документов.",
  "contents": "Подписывание служебных документов во внутреннем ДО."
}

AvailableWarrantForEmployee

Доступная доверенность сотрудника.

Название	Обязат.	Тип	Описание
number	Да	string	Номер доверенности.
isUsed	Да	boolean	Флаг показывающий используется ли даннная доверенность сотрудником.
startDate	Да	date-time-offset	Дата начала действия доверенности.
endDate	Да	date-time-offset	Срок окончания действия доверенности.
status	Да	Одна из: WarrantStatus	Статус доверенности.
representative	Да	Одна из: Representative	Данные о доверенном лице (кому выдана доверенность).
principal	Да	Одна из: Principal	Данные организации доверителя.
empowerments	Да	AreaOfEmpowerment[array]	Список полномочий доверенности.

Пример модели

{
  "number": "b46ec17f-649a-4240-80a4-f311939dd18e",
  "isUsed": true,
  "startDate": "2022-02-11T13:03:05.670Z",
  "endDate": "2022-02-11T13:03:05.670Z",
  "status": "Rejected",
  "representative": {
    "inn": "9672152699"
  },
  "principal": {
    "inn": "9681731710",
    "kpp": "Строка",
    "ogrn": "1666454467909",
    "organizationName": "Тестовая организация.",
    "personName": {
      "surname": "Константинопольский",
      "name": "Константин",
      "patronymic": "Константинович"
    }
  },
  "empowerments": [
    {
      "code": "404",
      "description": "Подписывание служебных документов.",
      "contents": "Подписывание служебных документов во внутреннем ДО."
    }
  ]
}

Certificate

Информация о сертификате.

Название	Обязат.	Тип	Описание
certificateSkid	Да	string	Skid сертификата.
certificateAuthority	Да	string	Наименование УЦ.
ownerSurname	Да	string	Фамилия владельца сертификата.
ownerName	Да	string	Имя владельца сертификата.
ownerPatronymic	Нет	string	Отчество владельца сертификата.
certificateNotAfter	Да	date-time	Дата окончания действия сертификата пользователя.
certificateNotBefore	Да	date-time	Дата начала действия сертификата пользователя.
serialNumber	Да	string	Серийный номер сертификата.
dssCertificateId	Нет	string(uuid)	DSS идентификатор сертификата.
certificateInn	Да	string	Инн сертификата.

Пример модели

{
  "certificateSkid": "d29d6128-2926-43f9-a386-0a9ec0c99ddd",
  "certificateAuthority": "Наименование УЦ",
  "ownerSurname": "Строка",
  "ownerName": "Строка",
  "ownerPatronymic": "Строка",
  "certificateNotAfter": "2022-02-11T13:03:05.670Z",
  "certificateNotBefore": "2022-02-11T13:03:05.670Z",
  "serialNumber": "5446565516848",
  "dssCertificateId": "60706ae1-6d47-48d2-9271-7c576153a265",
  "certificateInn": "963992394113"
}

ContactInfo

Информация о контактах сотрудника.

Название	Обязат.	Тип	Описание
email	Да	string	Email.
phone	Да	string	Номер телефона.

Пример модели

{
  "email": "test@test.ru",
  "phone": "+70000000000"
}

ContactsInfo

Информация о контактах сотрудника.

Название	Обязат.	Тип	Описание
email	Да	string	Email
phone	Да	string	Телефон

Пример модели

{
  "email": "k.konstantin@test.ru",
  "phone": "+79999999999"
}

CreateEmployeeRequest

Параметры запроса на создание сотрудника.

Название	Обязат.	Тип	Описание
surname	Да	string	Фамилия.
name	Да	string	Имя.
patronymic	Нет	string	Отчество.
roleId	Да	string(uuid)	Идентификатор роли.
email	Да	string	Адрес электронной почты.
phone	Да	string	Номер телефона.
position	Да	string	Должность в организации.
departmentInfo	Нет	Одна из: EmployeeDepartmentInfo	Настройки видимости подразделений и сведения о текущем подразделении

Пример модели

{
  "surname": "Константинопольский",
  "name": "Константин",
  "patronymic": "Константинович",
  "roleId": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
  "email": "k.konstantin@test.ru",
  "phone": "+79999999999",
  "position": "Супер-сотрудник",
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

DepartmentAccessLevel

Область видимости документов подразделений.

Значение	Описание
All	Сотрудник видит все подразделения организации.
ChildrenDepartments	Сотрудник видит только подразделение в котором, состоит и все дочерние подразделения.
CurrentDepartment	Сотрудник видит только подразделение в котором, состоит.
SpecifiedDepartments	Сотрудник видит подразделение в котором, состоит и подразделения назначенные администратором организации.

EmployeeDepartmentInfo

Настройки видимости подразделений и сведения о текущем подразделении

Название	Обязат.	Тип	Описание
departmentId	Да	string(uuid)	ИД подразделения в котором, состоит сотрудник.
accessLevel	Да	Одна из: DepartmentAccessLevel	Область видимости документов сотрудником организации.
visibleDepartments	Нет	string(uuid)[array]	Подразделения, которые назначены для видимости документов.

Пример модели

{
  "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
  "accessLevel": "SpecifiedDepartments",
  "visibleDepartments": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ]
}

EmployeeDepartmentInfoResponse

Настройки видимости подразделений сотрудника и сведения о текущем подразделении сотрудника.

Название	Обязат.	Тип	Описание
departmentId	Да	string(uuid)	ИД подразделения в котором, состоит сотрудник.
name	Да	string	Название подразделения в котором, состоит сотрудник.
accessLevel	Да	Одна из: DepartmentAccessLevel	Область видимости документов сотрудником организации.
visibleDepartments	Нет	string(uuid)[array]	Подразделения, которые назначены для видимости документов.

Пример модели

{
  "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
  "name": "Бухгалтерия",
  "accessLevel": "SpecifiedDepartments",
  "visibleDepartments": [
    "42F774E0-2325-45FA-A94D-F10A578A1EA0"
  ]
}

EmployeeFullInfo

Информация по сотруднику.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор сотрудника.
abonentId	Да	string(uuid)	Идентификатор абонента.
userId	Да	string(uuid)	Идентификатор пользователя.
inn	Нет	string	ИНН.
snils	Нет	string	СНИЛС.
status	Да	Одна из: EmployeeStatus	Статус сотрудника.
role	Да	Одна из: Role	Роль сотрудника.
position	Нет	string	Должность в организации.
contactInfo	Нет	Одна из: ContactInfo	Контактные данные
certificates	Да	Certificate[array]	Сертификаты
warrants	Нет	AvailableWarrantForEmployee[array]	Доверенности (МЧД).
fullName	Да	Одна из: PersonFullName	ФИО сотрудника.
departmentInfo	Да	Одна из: EmployeeDepartmentInfoResponse	Настройки видимости подразделений сотрудника и сведения о текущем подразделении сотрудника.

Пример модели

{
  "id": "71957841-691e-4436-b695-ee65625ae8d9",
  "abonentId": "8b1ea303-b01c-462f-bfe1-c996fbb33150",
  "userId": "a60f7d80-b9d9-4faa-a2f1-3d697c08d426",
  "inn": "9624440182",
  "snils": "149-558-345 11",
  "status": "Blocked",
  "role": {
    "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "name": "Owner.",
    "displayName": "Владелец.",
    "permissions": [
      "Строка"
    ]
  },
  "position": "Директор",
  "contactInfo": {
    "email": "test@test.ru",
    "phone": "+70000000000"
  },
  "certificates": [
    {
      "certificateSkid": "d29d6128-2926-43f9-a386-0a9ec0c99ddd",
      "certificateAuthority": "Наименование УЦ",
      "ownerSurname": "Строка",
      "ownerName": "Строка",
      "ownerPatronymic": "Строка",
      "certificateNotAfter": "2022-02-11T13:03:05.670Z",
      "certificateNotBefore": "2022-02-11T13:03:05.670Z",
      "serialNumber": "5446565516848",
      "dssCertificateId": "60706ae1-6d47-48d2-9271-7c576153a265",
      "certificateInn": "963992394113"
    }
  ],
  "warrants": [
    {
      "number": "b46ec17f-649a-4240-80a4-f311939dd18e",
      "isUsed": true,
      "startDate": "2022-02-11T13:03:05.670Z",
      "endDate": "2022-02-11T13:03:05.670Z",
      "status": "Rejected",
      "representative": {
        "inn": "9672152699"
      },
      "principal": {
        "inn": "9681731710",
        "kpp": "Строка",
        "ogrn": "1666454467909",
        "organizationName": "Тестовая организация.",
        "personName": {
          "surname": "Константинопольский",
          "name": "Константин",
          "patronymic": "Константинович"
        }
      },
      "empowerments": [
        {
          "code": "404",
          "description": "Подписывание служебных документов.",
          "contents": "Подписывание служебных документов во внутреннем ДО."
        }
      ]
    }
  ],
  "fullName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  },
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "name": "Бухгалтерия",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

EmployeeShortInfo

Информация о сотруднике.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор сотрудника.
abonentId	Да	string(uuid)	Идентификатор абонента.
userId	Да	string(uuid)	Идентификатор пользователя.
status	Да	Одна из: EmployeeStatus	Статус сотрудника.
role	Да	Одна из: Role	Роль сотрудника.
position	Нет	string	Должность в организации.
fullName	Да	Одна из: PersonFullName	ФИО сотрудника.

Пример модели

{
  "id": "71957841-691e-4436-b695-ee65625ae8d9",
  "abonentId": "8b1ea303-b01c-462f-bfe1-c996fbb33150",
  "userId": "a60f7d80-b9d9-4faa-a2f1-3d697c08d426",
  "status": "Blocked",
  "role": {
    "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
    "name": "Owner.",
    "displayName": "Владелец.",
    "permissions": [
      "Строка"
    ]
  },
  "position": "Директор",
  "fullName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  }
}

EmployeeShortInfoResultList

Список с результатом поиска.

Название	Обязат.	Тип	Описание
count	Да	integer(int32)	Количество элементов в результате.
data	Да	EmployeeShortInfo[array]	Список элементов в результате.

Пример модели

{
  "count": 1,
  "data": [
    {
      "id": "71957841-691e-4436-b695-ee65625ae8d9",
      "abonentId": "8b1ea303-b01c-462f-bfe1-c996fbb33150",
      "userId": "a60f7d80-b9d9-4faa-a2f1-3d697c08d426",
      "status": "Blocked",
      "role": {
        "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
        "name": "Owner.",
        "displayName": "Владелец.",
        "permissions": [
          "Строка"
        ]
      },
      "position": "Директор",
      "fullName": {
        "surname": "Константинопольский",
        "name": "Константин",
        "patronymic": "Константинович"
      }
    }
  ]
}

EmployeeStatus

Статус сотрудника.

Значение	Описание
Active	Активен.
Blocked	Заблокирован.
Inactive	Не активен.

PersonFullName

Модель данных по ФИО сотрудника.

Название	Обязат.	Тип	Описание
surname	Да	string	Фамилия.
name	Да	string	Имя.
patronymic	Нет	string	Отчество.

Пример модели

{
  "surname": "Константинопольский",
  "name": "Константин",
  "patronymic": "Константинович"
}

PersonFullNameInfo

Модель ФИО.

Название	Обязат.	Тип	Описание
surname	Да	string	Фамилия.
name	Да	string	Имя.
patronymic	Нет	string	Отчество.

Пример модели

{
  "surname": "Константинопольский",
  "name": "Константин",
  "patronymic": "Константинович"
}

Principal

Данные организации доверителя.

Название	Обязат.	Тип	Описание
inn	Да	string	ИНН.
kpp	Да	string	КПП.
ogrn	Да	string	ОГРН.
organizationName	Да	string	Наименование.
personName	Нет	Одна из: PersonFullName	ФИО доверителя, заполняется для ИП.

Пример модели

{
  "inn": "9681731710",
  "kpp": "Строка",
  "ogrn": "1666454467909",
  "organizationName": "Тестовая организация.",
  "personName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  }
}

Representative

Данные о доверенном лице (кому выдана доверенность).

Название	Обязат.	Тип	Описание
inn	Да	string	ИНН доверенного лица.

Пример модели

{
  "inn": "9672152699"
}

Role

Информация о роли.

Название	Обязат.	Тип	Описание
id	Да	string(uuid)	Идентификатор роли.
name	Да	string	Имя роли.
displayName	Да	string	Отображаемое название
permissions	Да	string[array]	Набор разрешений вида.

Пример модели

{
  "id": "42F774E0-2325-45FA-A94D-F10A578A1EA0",
  "name": "Owner.",
  "displayName": "Владелец.",
  "permissions": [
    "Строка"
  ]
}

UpdateEmployeeRequest

Параметры запроса на обновление данных сотрудника.

Название	Обязат.	Тип	Описание
fullName	Да	Одна из: PersonFullNameInfo	ФИО сотрудника
contactInfo	Да	Одна из: ContactsInfo	Контактные данные сотрудника
position	Да	string	Должность в организации
roleId	Да	string(uuid)	Идентификатор роли, применяется только если владелец или админ редактирует сотрудника
departmentInfo	Нет	Одна из: EmployeeDepartmentInfo	Настройки видимости подразделений и сведения о текущем подразделении

Пример модели

{
  "fullName": {
    "surname": "Константинопольский",
    "name": "Константин",
    "patronymic": "Константинович"
  },
  "contactInfo": {
    "email": "k.konstantin@test.ru",
    "phone": "+79999999999"
  },
  "position": "Супер-сотрудник",
  "roleId": "56877C86-73A4-4D97-BBCF-C63A44153C8C",
  "departmentInfo": {
    "departmentId": "2ede67e9-0f40-4294-ae18-0a84b0605a23",
    "accessLevel": "SpecifiedDepartments",
    "visibleDepartments": [
      "42F774E0-2325-45FA-A94D-F10A578A1EA0"
    ]
  }
}

WarrantStatus

Статусы доверенности.

Значение	Описание
Active	Действующая доверенность.
Created	Доверенность существует, но не вступила в действие.
Expired	Доверенность истекла.
Processing	Ожидает подтверждения (отправлена в ФНС)
Rejected	Отказ в регистрации (отклонена ФНС при регистрации)
Revoked	Доверенность отменена.

Employees API

Описание методов​

[POST]/api/v1/employees​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/employees​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/employees/{employeeId}​

Параметры в строке запроса​

Тело запроса​

Возможные ответы метода​

[GET]/api/v1/employees/{employeeId}​

Параметры в строке запроса​

Возможные ответы метода​

[GET]/api/v1/employees/roles​

Возможные ответы метода​

[GET]/api/v1/employees/current​

Параметры в строке запроса​

Возможные ответы метода​

[GET]/api/v1/employees/{employeeId}/warrants​

Параметры в строке запроса​

Возможные ответы метода​

[PUT]/api/v1/employees/{employeeId}/warrant/{warrantNumber}​

Параметры в строке запроса​

Возможные ответы метода​

[DELETE]/api/v1/employees/{employeeId}/warrant/{warrantNumber}​

Параметры в строке запроса​

Возможные ответы метода​

[POST]/api/v1/employees/{employeeId}/block​

Параметры в строке запроса​

Возможные ответы метода​

[POST]/api/v1/employees/{employeeId}/unblock​

Параметры в строке запроса​

Возможные ответы метода​

Описание дополнительных моделей​

AreaOfEmpowerment​

AvailableWarrantForEmployee​

Certificate​

ContactInfo​

ContactsInfo​

CreateEmployeeRequest​

DepartmentAccessLevel​

EmployeeDepartmentInfo​

EmployeeDepartmentInfoResponse​

EmployeeFullInfo​

EmployeeShortInfo​

EmployeeShortInfoResultList​

EmployeeStatus​

PersonFullName​

PersonFullNameInfo​

Principal​

Representative​

Role​

UpdateEmployeeRequest​

WarrantStatus​

Описание методов

[POST]/api/v1/employees

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[GET]/api/v1/employees

Параметры в строке запроса

Возможные ответы метода

[PUT]/api/v1/employees/{employeeId}

Параметры в строке запроса

Тело запроса

Возможные ответы метода

[GET]/api/v1/employees/{employeeId}

Параметры в строке запроса

Возможные ответы метода

[GET]/api/v1/employees/roles

Возможные ответы метода

[GET]/api/v1/employees/current

Параметры в строке запроса

Возможные ответы метода

[GET]/api/v1/employees/{employeeId}/warrants

Параметры в строке запроса

Возможные ответы метода

[PUT]/api/v1/employees/{employeeId}/warrant/{warrantNumber}

Параметры в строке запроса

Возможные ответы метода

[DELETE]/api/v1/employees/{employeeId}/warrant/{warrantNumber}

Параметры в строке запроса

Возможные ответы метода

[POST]/api/v1/employees/{employeeId}/block

Параметры в строке запроса

Возможные ответы метода

[POST]/api/v1/employees/{employeeId}/unblock

Параметры в строке запроса

Возможные ответы метода

Описание дополнительных моделей

AreaOfEmpowerment

AvailableWarrantForEmployee

Certificate

ContactInfo

ContactsInfo

CreateEmployeeRequest

DepartmentAccessLevel

EmployeeDepartmentInfo

EmployeeDepartmentInfoResponse

EmployeeFullInfo

EmployeeShortInfo

EmployeeShortInfoResultList

EmployeeStatus

PersonFullName

PersonFullNameInfo

Principal

Representative

Role

UpdateEmployeeRequest

WarrantStatus