User#
- 1. Property
User > id - 2. Property
User > type - 3. Property
User > customer - 3.1. Property
User > customer > id - 3.2. Property
User > customer > createdBy - 3.3. Property
User > customer > type - 3.4. Property
User > customer > status - 3.5. Property
User > customer > statusPrevious - 3.6. Property
User > customer > email - 3.7. Property
User > customer > partner - 3.8. Property
User > customer > signingType - 3.9. Property
User > customer > canRequestSubsidiary - 3.10. Property
User > customer > prioritySubsidiaries - 4. Property
User > employee - 4.1. Property
User > employee > fio - 5. Property
User > agent - 5.1. Property
User > agent > id - 5.2. Property
User > agent > customer - 5.3. Property
User > agent > fullName - 5.4. Property
User > agent > fullNameEnglish - 5.5. Property
User > agent > inn - 5.6. Property
User > agent > kpp - 5.7. Property
User > agent > ogrn - 5.8. Property
User > agent > bankAccount - 5.9. Property
User > agent > addressRegistration - 5.10. Property
User > agent > addressRegistrationEnglish - 5.11. Property
User > agent > taxResidence - 5.12. Property
User > agent > representative - 5.13. Property
User > agent > stampPath - 5.14. Property
User > agent > additionalProperties - 5.15. Property
User > agent > required - 5.16. Property
User > agent > status - 6. Property
User > email - 7. Property
User > phone - 8. Property
User > role - 9. Property
User > status - 10. Property
User > statusPrevious - 11. Property
User > statusReason - 12. Property
User > passwordMistakeCounter
Title: User
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Пользователь
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + id | No | string | No | - | Уникальный идентификатор |
| + type | No | enum (of string) | No | - | Тип пользователя - `CUSTOMER`: клиент - `EMPLOYEE`: исполнитель - `AGENT`: агент |
| - customer | No | object | No | In customer.schema.json | Customer |
| - employee | No | object | No | In employee.schema.json | Employee |
| - agent | No | object | No | In agent.schema.json | Agent |
| No | string | No | Same as email | E-mail пользователя | |
| + phone | No | string | No | - | Номер мобильного телефона |
| + role | No | enum (of string) | No | - | Роль пользователя |
| + status | No | enum (of string) | No | Same as status | Статус пользователя |
| - statusPrevious | No | enum (of string) | No | Same as status | Предыдущий статус пользователя |
| - statusReason | No | enum (of string) | No | - | Причина установки текущего статуса - `PASSWORD_MISTAKE`: ошибка ввода пароля - `MANUAL_BLOCKED`: ручная блокировка |
| - passwordMistakeCounter | No | number | No | - | Количество попыток ошибочного ввода пароля при входе в систему |
1. Property User > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Уникальный идентификатор
2. Property User > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип пользователя
CUSTOMER: клиентEMPLOYEE: исполнительAGENT: агент
Must be one of: * "CUSTOMER" * "EMPLOYEE" * "AGENT"
3. Property User > customer#
Title: Customer
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | customer.schema.json |
Description: Клиент
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + id | No | string | No | - | Уникальный идентификатор |
| - createdBy | No | string | No | - | id пользователя, создавшего клиента |
| + type | No | enum (of string) | No | - | Тип заказчика - `COMPANY`: юр.лицо - `PERSON`: физ.лицо - `IP`: индивидуальный предприниматель |
| + status | No | enum (of string) | No | In common/_common.schema.json#/status | Статус клиента |
| - statusPrevious | No | enum (of string) | No | Same as status | Предыдущий статус клиента |
| No | string | No | In common/_common.schema.json#/email | E-mail клиента | |
| + partner | No | string | No | - | Партнер |
| - signingType | No | enum (of string) | No | - | Способ подписания документов - `HANDWRITTEN`: подписание вручную - `SIMPLE_ELECTRONIC`: ПЭП |
| - canRequestSubsidiary | No | boolean | No | - | Может запрашивать согласование плательщика |
| - prioritySubsidiaries | No | array | No | - | - |
3.1. Property User > customer > id#
| Type | string |
| Required | Yes |
| Format | uuid |
Description: Уникальный идентификатор
3.2. Property User > customer > createdBy#
| Type | string |
| Required | No |
Description: id пользователя, создавшего клиента
3.3. Property User > customer > type#
| Type | enum (of string) |
| Required | Yes |
Description: Тип заказчика
COMPANY: юр.лицоPERSON: физ.лицоIP: индивидуальный предприниматель
Must be one of: * "COMPANY" * "PERSON" * "IP"
3.4. Property User > customer > status#
| Type | enum (of string) |
| Required | Yes |
| Defined in | common/_common.schema.json#/status |
Description: Статус клиента
Must be one of: * "ACTIVE" * "INACTIVE" * "INVITED"
3.5. Property User > customer > statusPrevious#
| Type | enum (of string) |
| Required | No |
| Same definition as | status |
Description: Предыдущий статус клиента
3.6. Property User > customer > email#
| Type | string |
| Required | No |
| Defined in | common/_common.schema.json#/email |
Description: E-mail клиента
| Restrictions | |
|---|---|
| Must match regular expression | (?=^[\w\W]{0,255}$)^\s*(?:[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{\|}~-]+)*\|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\|\[(?:(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9]))\.){3}(?:(2(5[0-5]\|[0-4][0-9])\|1[0-9][0-9]\|[1-9]?[0-9])\|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]\|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])\s*$ Test |
3.7. Property User > customer > partner#
| Type | string |
| Required | Yes |
Description: Партнер
3.8. Property User > customer > signingType#
| Type | enum (of string) |
| Required | No |
Description: Способ подписания документов
HANDWRITTEN: подписание вручнуюSIMPLE_ELECTRONIC: ПЭП
Must be one of: * "SIMPLE_ELECTRONIC" * "HANDWRITTEN"
3.9. Property User > customer > canRequestSubsidiary#
| Type | boolean |
| Required | No |
Description: Может запрашивать согласование плательщика
3.10. Property User > customer > prioritySubsidiaries#
| Type | array |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | N/A |
4. Property User > employee#
Title: Employee
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | employee.schema.json |
Description: Сотрудник
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + fio | No | object | No | In common/_common.schema.json#/fio | ФИО |
4.1. Property User > employee > fio#
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
| Defined in | common/_common.schema.json#/fio |
Description: ФИО
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + lastName | No | string | No | - | Фамилия |
| + firstName | No | string | No | - | Имя |
| - patronymic | No | string | No | - | Отчество |
4.1.1. Property User > employee > fio > lastName#
| Type | string |
| Required | Yes |
Description: Фамилия
4.1.2. Property User > employee > fio > firstName#
| Type | string |
| Required | Yes |
Description: Имя
4.1.3. Property User > employee > fio > patronymic#
| Type | string |
| Required | No |
Description: Отчество
5. Property User > agent#
Title: Agent
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | agent.schema.json |
Description: Agent
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - id | No | string | No | - | Уникальный идентификатор |
| - customer | No | object | No | - | - |
| - fullName | No | string | No | - | Название |
| - fullNameEnglish | No | string | No | - | Название на английском языке |
| - inn | No | string | No | - | ИНН |
| - kpp | No | string | No | - | КПП |
| - ogrn | No | string | No | - | ОГРН |
| - bankAccount | No | array of object | No | Same as bankAccounts | Реквизиты банковского счета |
| - addressRegistration | No | object | No | Same as addressRegistrationEnglish | Адрес регистрации |
| - addressRegistrationEnglish | No | object | No | Same as addressRegistrationEnglish | Адрес регистрации на английском языке |
| - taxResidence | No | string | No | In common/_common.schema.json#/country | Страна налогового резидентства |
| - representative | No | object | No | Same as representative | Подписант |
| - stampPath | No | string | No | - | Путь к файлу с изображением штампа |
| - additionalProperties | No | object | No | - | - |
| - required | No | object | No | - | - |
| + status | No | enum (of string) | No | - | Статус - `ACTIVE`: действующий агент - `INACTIVE`: заблокированный агент |
5.1. Property User > agent > id#
| Type | string |
| Required | No |
| Format | uuid |
Description: Уникальный идентификатор
5.2. Property User > agent > customer#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
5.3. Property User > agent > fullName#
| Type | string |
| Required | No |
Description: Название
5.4. Property User > agent > fullNameEnglish#
| Type | string |
| Required | No |
Description: Название на английском языке
5.5. Property User > agent > inn#
| Type | string |
| Required | No |
Description: ИНН
5.6. Property User > agent > kpp#
| Type | string |
| Required | No |
Description: КПП
| Restrictions | |
|---|---|
| Min length | 9 |
| Max length | 9 |
| Must match regular expression | ^[0-9]{9}$ Test |
5.7. Property User > agent > ogrn#
| Type | string |
| Required | No |
Description: ОГРН
5.8. Property User > agent > bankAccount#
| Type | array of object |
| Required | No |
| Same definition as | bankAccounts |
Description: Реквизиты банковского счета
5.9. Property User > agent > addressRegistration#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | addressRegistrationEnglish |
Description: Адрес регистрации
5.10. Property User > agent > addressRegistrationEnglish#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Same definition as | addressRegistrationEnglish |
Description: Адрес регистрации на английском языке
5.11. Property User > agent > taxResidence#
| Type | string |
| Required | No |
| Defined in | common/_common.schema.json#/country |
Description: Страна налогового резидентства
| Restrictions | |
|---|---|
| Min length | 3 |
| Max length | 3 |
| Must match regular expression | ^[A-Z]{3}$ Test |
5.12. Property User > agent > representative#
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | representative |
Description: Подписант
5.13. Property User > agent > stampPath#
| Type | string |
| Required | No |
Description: Путь к файлу с изображением штампа
5.14. Property User > agent > additionalProperties#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
5.15. Property User > agent > required#
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
5.16. Property User > agent > status#
| Type | enum (of string) |
| Required | Yes |
Description: Статус
ACTIVE: действующий агентINACTIVE: заблокированный агент
Must be one of: * "ACTIVE" * "INACTIVE"
6. Property User > email#
| Type | string |
| Required | Yes |
| Same definition as |
Description: E-mail пользователя
7. Property User > phone#
| Type | string |
| Required | Yes |
Description: Номер мобильного телефона
| Restrictions | |
|---|---|
| Must match regular expression | ^(79)\d{9}$ Test |
8. Property User > role#
| Type | enum (of string) |
| Required | Yes |
Description: Роль пользователя
Must be one of: * "ADMINISTRATOR" * "CONTRACTOR" * "CUSTOMER" * "OBSERVER"
9. Property User > status#
| Type | enum (of string) |
| Required | Yes |
| Same definition as | status |
Description: Статус пользователя
10. Property User > statusPrevious#
| Type | enum (of string) |
| Required | No |
| Same definition as | status |
Description: Предыдущий статус пользователя
11. Property User > statusReason#
| Type | enum (of string) |
| Required | No |
Description: Причина установки текущего статуса
PASSWORD_MISTAKE: ошибка ввода пароляMANUAL_BLOCKED: ручная блокировка
Must be one of: * "PASSWORD_MISTAKE" * "MANUAL_BLOCKED"
12. Property User > passwordMistakeCounter#
| Type | number |
| Required | No |
Description: Количество попыток ошибочного ввода пароля при входе в систему
Generated using json-schema-for-humans on 2025-02-11 at 14:28:17 +0000