# Протокол

## Оглавление

- [keyapis/preset/v1/keyapis_preset_preset_v1.proto](#keyapis_preset_v1_keyapis_preset_preset_v1-proto)
    - [PresetService](#keyapis-preset-v1-PresetService)
  
    - [DeletePresetRequest](#keyapis-preset-v1-DeletePresetRequest)
    - [DeletePresetResponse](#keyapis-preset-v1-DeletePresetResponse)
    - [DeletePresetResponse.Error](#keyapis-preset-v1-DeletePresetResponse-Error)
    - [DeletePresetResponse.Error.NotAllowedForDefault](#keyapis-preset-v1-DeletePresetResponse-Error-NotAllowedForDefault)
    - [GetPresetCountRequest](#keyapis-preset-v1-GetPresetCountRequest)
    - [GetPresetCountResponse](#keyapis-preset-v1-GetPresetCountResponse)
    - [GetPresetCountResponse.Error](#keyapis-preset-v1-GetPresetCountResponse-Error)
    - [GetPresetDefaultRequest](#keyapis-preset-v1-GetPresetDefaultRequest)
    - [GetPresetDefaultResponse](#keyapis-preset-v1-GetPresetDefaultResponse)
    - [GetPresetListRequest](#keyapis-preset-v1-GetPresetListRequest)
    - [GetPresetListResponse](#keyapis-preset-v1-GetPresetListResponse)
    - [GetPresetListResponse.Error](#keyapis-preset-v1-GetPresetListResponse-Error)
    - [GetPresetRequest](#keyapis-preset-v1-GetPresetRequest)
    - [GetPresetResponse](#keyapis-preset-v1-GetPresetResponse)
    - [PostPresetRequest](#keyapis-preset-v1-PostPresetRequest)
    - [PostPresetResponse](#keyapis-preset-v1-PostPresetResponse)
    - [PostPresetResponse.Error](#keyapis-preset-v1-PostPresetResponse-Error)
    - [Preset](#keyapis-preset-v1-Preset)
    - [Preset.Dtmf](#keyapis-preset-v1-Preset-Dtmf)
    - [Preset.FaceRecognition](#keyapis-preset-v1-Preset-FaceRecognition)
    - [Preset.Ntp](#keyapis-preset-v1-Preset-Ntp)
    - [Preset.Room](#keyapis-preset-v1-Preset-Room)
    - [Preset.SavingError](#keyapis-preset-v1-Preset-SavingError)
    - [Preset.SavingError.Conflict](#keyapis-preset-v1-Preset-SavingError-Conflict)
    - [Preset.SavingError.NotAllowedForDefault](#keyapis-preset-v1-Preset-SavingError-NotAllowedForDefault)
    - [Preset.Sip](#keyapis-preset-v1-Preset-Sip)
    - [Preset.Syslog](#keyapis-preset-v1-Preset-Syslog)
    - [Preset.VideoConfig](#keyapis-preset-v1-Preset-VideoConfig)
    - [Preset.VideoConfig.RtspUser](#keyapis-preset-v1-Preset-VideoConfig-RtspUser)
    - [PresetFilter](#keyapis-preset-v1-PresetFilter)
    - [PresetPaging](#keyapis-preset-v1-PresetPaging)
    - [ValidationError](#keyapis-preset-v1-ValidationError)
  
    - [Preset.FaceRecognition.ConfigurationType](#keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType)
    - [Preset.StatusType](#keyapis-preset-v1-Preset-StatusType)
    - [Preset.Syslog.ProtocolType](#keyapis-preset-v1-Preset-Syslog-ProtocolType)
    - [Preset.VideoConfig.QualityType](#keyapis-preset-v1-Preset-VideoConfig-QualityType)
    - [PresetPaging.DirectionType](#keyapis-preset-v1-PresetPaging-DirectionType)
    - [PresetPaging.OrderByType](#keyapis-preset-v1-PresetPaging-OrderByType)
  


## [Схема классов](/svg/protos/key/keyapis/preset/v1/keyapis_preset_preset_v1.proto.svg)
<a href="/svg/protos/key/keyapis/preset/v1/keyapis_preset_preset_v1.proto.svg"><img src="/svg/protos/key/keyapis/preset/v1/keyapis_preset_preset_v1.proto.svg" alt="/svg/protos/key/keyapis/preset/v1/keyapis_preset_preset_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_preset_v1_keyapis_preset_preset_v1-proto"></a>

## [keyapis/preset/v1/keyapis_preset_preset_v1.proto](/protos/key/keyapis/preset/v1/keyapis_preset_preset_v1.proto)
Сервис реализует функционал хранения пресетов устройств


<a name="keyapis-preset-v1-PresetService"></a>

### PresetService
 Сервис пресетов

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-preset-v1-PostPreset"></a> [PostPreset](#keyapis-preset-v1-PostPreset) | Метод сохранения пресетов. Поддерживает создание и обновление. При обновлении пресета посылается задача PresetInstallTask в очередь key.preset.install. Данное сообщение должно отправляться только если изменению подверглось одно из следующих полей: - Sip; - Ntp; - Syslog; - Room; - VideoConfig; - Dtmf. Метод доступен для: admin, service | [keyapis.preset.v1.PostPresetRequest](#keyapis-preset-v1-PostPresetRequest) | [keyapis.preset.v1.PostPresetResponse](#keyapis-preset-v1-PostPresetResponse) |
| <a id="keyapis-preset-v1-GetPreset"></a> [GetPreset](#keyapis-preset-v1-GetPreset) | Метод получения пресета по идентификатору. Метод доступен для: admin, service, bti, ltp_first, owner, employee | [keyapis.preset.v1.GetPresetRequest](#keyapis-preset-v1-GetPresetRequest) | [keyapis.preset.v1.GetPresetResponse](#keyapis-preset-v1-GetPresetResponse) |
| <a id="keyapis-preset-v1-GetPresetDefault"></a> [GetPresetDefault](#keyapis-preset-v1-GetPresetDefault) | Метод получения дефолтного пресета. Метод доступен для: admin, service, bti, ltp_first, owner, employee | [keyapis.preset.v1.GetPresetDefaultRequest](#keyapis-preset-v1-GetPresetDefaultRequest) | [keyapis.preset.v1.GetPresetDefaultResponse](#keyapis-preset-v1-GetPresetDefaultResponse) |
| <a id="keyapis-preset-v1-GetPresetList"></a> [GetPresetList](#keyapis-preset-v1-GetPresetList) | Метод получения пресетов. Метод доступен для: admin, service, bti, ltp_first, owner, employee | [keyapis.preset.v1.GetPresetListRequest](#keyapis-preset-v1-GetPresetListRequest) | [keyapis.preset.v1.GetPresetListResponse](#keyapis-preset-v1-GetPresetListResponse) stream |
| <a id="keyapis-preset-v1-GetPresetCount"></a> [GetPresetCount](#keyapis-preset-v1-GetPresetCount) | Метод получения количества пресетов. Метод доступен для: admin, service, bti, ltp_first, owner, employee | [keyapis.preset.v1.GetPresetCountRequest](#keyapis-preset-v1-GetPresetCountRequest) | [keyapis.preset.v1.GetPresetCountResponse](#keyapis-preset-v1-GetPresetCountResponse) |
| <a id="keyapis-preset-v1-DeletePreset"></a> [DeletePreset](#keyapis-preset-v1-DeletePreset) | Метод удаления пресета. Нельзя удалить пресет, если он используется на устройстве. Нельзя удалить дефолтный пресет. Метод доступен для: admin, service | [keyapis.preset.v1.DeletePresetRequest](#keyapis-preset-v1-DeletePresetRequest) | [keyapis.preset.v1.DeletePresetResponse](#keyapis-preset-v1-DeletePresetResponse) |

 <!-- end services -->


<a name="keyapis-preset-v1-DeletePresetRequest"></a>


### [DeletePresetRequest](#keyapis-preset-v1-DeletePresetRequest)
 Запрос удаления пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-DeletePresetRequest-id"></a> [id](#keyapis-preset-v1-DeletePresetRequest-id) | Идентификатор пресета |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-DeletePresetResponse"></a>


### [DeletePresetResponse](#keyapis-preset-v1-DeletePresetResponse)
 Ответ на запрос удаления пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-DeletePresetResponse-error"></a> [error](#keyapis-preset-v1-DeletePresetResponse-error) | Ошибка при удалении |  optional  [keyapis.preset.v1.DeletePresetResponse.Error](#keyapis-preset-v1-DeletePresetResponse-Error) | <nil>|






<a name="keyapis-preset-v1-DeletePresetResponse-Error"></a>


### [DeletePresetResponse.Error](#keyapis-preset-v1-DeletePresetResponse-Error)
 Ошибка при удалении


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-DeletePresetResponse-Error-not_allowed_for_default"></a> [not_allowed_for_default](#keyapis-preset-v1-DeletePresetResponse-Error-not_allowed_for_default) | Запрещено для дефолтного пресета |  optional  [keyapis.preset.v1.DeletePresetResponse.Error.NotAllowedForDefault](#keyapis-preset-v1-DeletePresetResponse-Error-NotAllowedForDefault) | <nil>|






<a name="keyapis-preset-v1-DeletePresetResponse-Error-NotAllowedForDefault"></a>


### [DeletePresetResponse.Error.NotAllowedForDefault](#keyapis-preset-v1-DeletePresetResponse-Error-NotAllowedForDefault)
 Недоступно для дефолтного пресета






<a name="keyapis-preset-v1-GetPresetCountRequest"></a>


### [GetPresetCountRequest](#keyapis-preset-v1-GetPresetCountRequest)
 Запрос получения количества пресетов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetCountRequest-filter"></a> [filter](#keyapis-preset-v1-GetPresetCountRequest-filter) | Фильтр |    [keyapis.preset.v1.PresetFilter](#keyapis-preset-v1-PresetFilter) | <nil>|






<a name="keyapis-preset-v1-GetPresetCountResponse"></a>


### [GetPresetCountResponse](#keyapis-preset-v1-GetPresetCountResponse)
 Ответ на запрос получения количества пресетов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetCountResponse-data"></a> [data](#keyapis-preset-v1-GetPresetCountResponse-data) | Всего пресетов |  optional  [int32](#scalar-types) | <nil>|
| <a id="keyapis-preset-v1-GetPresetCountResponse-error"></a> [error](#keyapis-preset-v1-GetPresetCountResponse-error) | Ошибка |  optional  [keyapis.preset.v1.GetPresetCountResponse.Error](#keyapis-preset-v1-GetPresetCountResponse-Error) | <nil>|






<a name="keyapis-preset-v1-GetPresetCountResponse-Error"></a>


### [GetPresetCountResponse.Error](#keyapis-preset-v1-GetPresetCountResponse-Error)
 Ошибка запроса получения количества пресетов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetCountResponse-Error-validation"></a> [validation](#keyapis-preset-v1-GetPresetCountResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.preset.v1.ValidationError](#keyapis-preset-v1-ValidationError) | <nil>|






<a name="keyapis-preset-v1-GetPresetDefaultRequest"></a>


### [GetPresetDefaultRequest](#keyapis-preset-v1-GetPresetDefaultRequest)
 Запрос получения дефолтного пресета






<a name="keyapis-preset-v1-GetPresetDefaultResponse"></a>


### [GetPresetDefaultResponse](#keyapis-preset-v1-GetPresetDefaultResponse)
 Ответ на запрос получения дефолтного пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetDefaultResponse-data"></a> [data](#keyapis-preset-v1-GetPresetDefaultResponse-data) | Пресет |  optional  [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | <nil>|






<a name="keyapis-preset-v1-GetPresetListRequest"></a>


### [GetPresetListRequest](#keyapis-preset-v1-GetPresetListRequest)
 Запрос на получение списка пресетов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetListRequest-filter"></a> [filter](#keyapis-preset-v1-GetPresetListRequest-filter) | Фильтр |    [keyapis.preset.v1.PresetFilter](#keyapis-preset-v1-PresetFilter) | <nil>|
| <a id="keyapis-preset-v1-GetPresetListRequest-paging"></a> [paging](#keyapis-preset-v1-GetPresetListRequest-paging) | Стандартный постраничный вывод |  optional  [keyapis.preset.v1.PresetPaging](#keyapis-preset-v1-PresetPaging) | <nil>|






<a name="keyapis-preset-v1-GetPresetListResponse"></a>


### [GetPresetListResponse](#keyapis-preset-v1-GetPresetListResponse)
 Ответ на получение списка пресетов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetListResponse-data"></a> [data](#keyapis-preset-v1-GetPresetListResponse-data) | Пресет |  optional  [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | <nil>|
| <a id="keyapis-preset-v1-GetPresetListResponse-error"></a> [error](#keyapis-preset-v1-GetPresetListResponse-error) | Ошибка |  optional  [keyapis.preset.v1.GetPresetListResponse.Error](#keyapis-preset-v1-GetPresetListResponse-Error) | <nil>|






<a name="keyapis-preset-v1-GetPresetListResponse-Error"></a>


### [GetPresetListResponse.Error](#keyapis-preset-v1-GetPresetListResponse-Error)
 Ошибка запроса получения списка пресетов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetListResponse-Error-validation"></a> [validation](#keyapis-preset-v1-GetPresetListResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.preset.v1.ValidationError](#keyapis-preset-v1-ValidationError) | <nil>|






<a name="keyapis-preset-v1-GetPresetRequest"></a>


### [GetPresetRequest](#keyapis-preset-v1-GetPresetRequest)
 Запрос получения пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetRequest-id"></a> [id](#keyapis-preset-v1-GetPresetRequest-id) | Идентификатор |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-GetPresetResponse"></a>


### [GetPresetResponse](#keyapis-preset-v1-GetPresetResponse)
 Ответ на запрос получения пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-GetPresetResponse-data"></a> [data](#keyapis-preset-v1-GetPresetResponse-data) | Пресет |  optional  [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | <nil>|






<a name="keyapis-preset-v1-PostPresetRequest"></a>


### [PostPresetRequest](#keyapis-preset-v1-PostPresetRequest)
 Запрос на создание/изменение пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PostPresetRequest-data"></a> [data](#keyapis-preset-v1-PostPresetRequest-data) | Пресет |    [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | REQUIRED|






<a name="keyapis-preset-v1-PostPresetResponse"></a>


### [PostPresetResponse](#keyapis-preset-v1-PostPresetResponse)
 Ответ на запрос на создание/изменение пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PostPresetResponse-data"></a> [data](#keyapis-preset-v1-PostPresetResponse-data) | Пресет |  optional  [keyapis.preset.v1.Preset](#keyapis-preset-v1-Preset) | <nil>|
| <a id="keyapis-preset-v1-PostPresetResponse-error"></a> [error](#keyapis-preset-v1-PostPresetResponse-error) | Ошибка |  optional  [keyapis.preset.v1.PostPresetResponse.Error](#keyapis-preset-v1-PostPresetResponse-Error) | <nil>|






<a name="keyapis-preset-v1-PostPresetResponse-Error"></a>


### [PostPresetResponse.Error](#keyapis-preset-v1-PostPresetResponse-Error)
 Ошибка запроса сохранения пресета


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PostPresetResponse-Error-validation"></a> [validation](#keyapis-preset-v1-PostPresetResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.preset.v1.ValidationError](#keyapis-preset-v1-ValidationError) | <nil>|
| <a id="keyapis-preset-v1-PostPresetResponse-Error-saving"></a> [saving](#keyapis-preset-v1-PostPresetResponse-Error-saving) | Ошибка сохранения |  optional  [keyapis.preset.v1.Preset.SavingError](#keyapis-preset-v1-Preset-SavingError) | <nil>|






<a name="keyapis-preset-v1-Preset"></a>


### [Preset](#keyapis-preset-v1-Preset)
 Пресет.
Пресет с id=1 является дефолтным пресетом.
# Описание модели


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-id"></a> [id](#keyapis-preset-v1-Preset-id) | Идентификатор. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-preset-v1-Preset-title"></a> [title](#keyapis-preset-v1-Preset-title) | Наименование. # Диапазон: 3..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-mrf_ids"></a> [mrf_ids](#keyapis-preset-v1-Preset-mrf_ids) | Идентификатор МРФ. # Диапазон: 0..10 |  repeated  [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-rf_ids"></a> [rf_ids](#keyapis-preset-v1-Preset-rf_ids) | Идентификатор РФ. # Диапазон: 0..100 |  repeated  [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-description"></a> [description](#keyapis-preset-v1-Preset-description) | Описание. # Диапазон: 3..1024 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OPTIONAL|
| <a id="keyapis-preset-v1-Preset-created_at"></a> [created_at](#keyapis-preset-v1-Preset-created_at) | Дата и время создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-preset-v1-Preset-changed_at"></a> [changed_at](#keyapis-preset-v1-Preset-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-preset-v1-Preset-status_type"></a> [status_type](#keyapis-preset-v1-Preset-status_type) | Статус |    [keyapis.preset.v1.Preset.StatusType](#keyapis-preset-v1-Preset-StatusType) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-sip"></a> [sip](#keyapis-preset-v1-Preset-sip) | Параметр SIP |    [keyapis.preset.v1.Preset.Sip](#keyapis-preset-v1-Preset-Sip) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-ntp"></a> [ntp](#keyapis-preset-v1-Preset-ntp) | Параметр NTP |    [keyapis.preset.v1.Preset.Ntp](#keyapis-preset-v1-Preset-Ntp) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-syslog"></a> [syslog](#keyapis-preset-v1-Preset-syslog) | Параметр Syslog |    [keyapis.preset.v1.Preset.Syslog](#keyapis-preset-v1-Preset-Syslog) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-rooms"></a> [rooms](#keyapis-preset-v1-Preset-rooms) | Помещения. # Диапазон: 0..10000 |  repeated  [keyapis.preset.v1.Preset.Room](#keyapis-preset-v1-Preset-Room) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-video_config"></a> [video_config](#keyapis-preset-v1-Preset-video_config) | Параметры конфигурации видео |    [keyapis.preset.v1.Preset.VideoConfig](#keyapis-preset-v1-Preset-VideoConfig) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-dtmf"></a> [dtmf](#keyapis-preset-v1-Preset-dtmf) | Параметр DTMF. # Диапазон: 0..64 |  repeated  [keyapis.preset.v1.Preset.Dtmf](#keyapis-preset-v1-Preset-Dtmf) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-face_recognition"></a> [face_recognition](#keyapis-preset-v1-Preset-face_recognition) | Распознование лиц |    [keyapis.preset.v1.Preset.FaceRecognition](#keyapis-preset-v1-Preset-FaceRecognition) | <nil>|






<a name="keyapis-preset-v1-Preset-Dtmf"></a>


### [Preset.Dtmf](#keyapis-preset-v1-Preset-Dtmf)
 Параметр DTMF


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-Dtmf-code"></a> [code](#keyapis-preset-v1-Preset-Dtmf-code) | Код. # Диапазон: 1..1 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Dtmf-relay_index"></a> [relay_index](#keyapis-preset-v1-Preset-Dtmf-relay_index) | Индекс реле. # Диапазон: 0..64 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-preset-v1-Preset-FaceRecognition"></a>


### [Preset.FaceRecognition](#keyapis-preset-v1-Preset-FaceRecognition)
 Распознование лиц


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-FaceRecognition-host"></a> [host](#keyapis-preset-v1-Preset-FaceRecognition-host) | Адрес |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-FaceRecognition-alt_host"></a> [alt_host](#keyapis-preset-v1-Preset-FaceRecognition-alt_host) | Альтернативный адрес |    [string](#scalar-types) | <nil>|
| <a id="keyapis-preset-v1-Preset-FaceRecognition-endpoint"></a> [endpoint](#keyapis-preset-v1-Preset-FaceRecognition-endpoint) | Путь запроса к серверу |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-FaceRecognition-auth_token"></a> [auth_token](#keyapis-preset-v1-Preset-FaceRecognition-auth_token) | Токен |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-FaceRecognition-configuration_type"></a> [configuration_type](#keyapis-preset-v1-Preset-FaceRecognition-configuration_type) | Тип конфигурации |    [keyapis.preset.v1.Preset.FaceRecognition.ConfigurationType](#keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-FaceRecognition-origin_id"></a> [origin_id](#keyapis-preset-v1-Preset-FaceRecognition-origin_id) | Идентификатор источника в identix |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-FaceRecognition-group_ids"></a> [group_ids](#keyapis-preset-v1-Preset-FaceRecognition-group_ids) | Идентификаторы групп профилей в identix |  repeated  [int32](#scalar-types) | <nil>|






<a name="keyapis-preset-v1-Preset-Ntp"></a>


### [Preset.Ntp](#keyapis-preset-v1-Preset-Ntp)
 Параметр NTP


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-Ntp-host"></a> [host](#keyapis-preset-v1-Preset-Ntp-host) | Хост. # Диапазон: 5..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Ntp-port"></a> [port](#keyapis-preset-v1-Preset-Ntp-port) | Порт. # Диапазон: 1..65536 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-Preset-Room"></a>


### [Preset.Room](#keyapis-preset-v1-Preset-Room)
 Помещение


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-Room-phone"></a> [phone](#keyapis-preset-v1-Preset-Room-phone) | Номер телефона. # Диапазон: 5..14 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Room-num"></a> [num](#keyapis-preset-v1-Preset-Room-num) | Номер помещения. # Диапазон: 1..10000 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-Preset-SavingError"></a>


### [Preset.SavingError](#keyapis-preset-v1-Preset-SavingError)
 Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-SavingError-conflict"></a> [conflict](#keyapis-preset-v1-Preset-SavingError-conflict) | Конфликт версий |  optional  [keyapis.preset.v1.Preset.SavingError.Conflict](#keyapis-preset-v1-Preset-SavingError-Conflict) | <nil>|
| <a id="keyapis-preset-v1-Preset-SavingError-not_allowed_for_default"></a> [not_allowed_for_default](#keyapis-preset-v1-Preset-SavingError-not_allowed_for_default) | Запрещено для дефолтного пресета |  optional  [keyapis.preset.v1.Preset.SavingError.NotAllowedForDefault](#keyapis-preset-v1-Preset-SavingError-NotAllowedForDefault) | <nil>|






<a name="keyapis-preset-v1-Preset-SavingError-Conflict"></a>


### [Preset.SavingError.Conflict](#keyapis-preset-v1-Preset-SavingError-Conflict)
 Конфликт версий.
Причины:
- В базе хранится другая версия строки, значения changed_at отличаются






<a name="keyapis-preset-v1-Preset-SavingError-NotAllowedForDefault"></a>


### [Preset.SavingError.NotAllowedForDefault](#keyapis-preset-v1-Preset-SavingError-NotAllowedForDefault)
 Недоступно для дефолтного пресета.
Причины:
- Смена статуса на Архивный






<a name="keyapis-preset-v1-Preset-Sip"></a>


### [Preset.Sip](#keyapis-preset-v1-Preset-Sip)
 Параметр SIP


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-Sip-host"></a> [host](#keyapis-preset-v1-Preset-Sip-host) | Хост. # Диапазон: 5..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Sip-port"></a> [port](#keyapis-preset-v1-Preset-Sip-port) | Порт. # Диапазон: 1..65536 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Sip-reg_host"></a> [reg_host](#keyapis-preset-v1-Preset-Sip-reg_host) | Хост reg. # Диапазон: 5..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Sip-reg_port"></a> [reg_port](#keyapis-preset-v1-Preset-Sip-reg_port) | Порт reg. # Диапазон: 1..65536 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Sip-proxy_host"></a> [proxy_host](#keyapis-preset-v1-Preset-Sip-proxy_host) | Хост proxy. # Диапазон: 5..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Sip-proxy_port"></a> [proxy_port](#keyapis-preset-v1-Preset-Sip-proxy_port) | Порт proxy. # Диапазон: 1..65536 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-Preset-Syslog"></a>


### [Preset.Syslog](#keyapis-preset-v1-Preset-Syslog)
 Параметр Syslog


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-Syslog-host"></a> [host](#keyapis-preset-v1-Preset-Syslog-host) | Хост. # Диапазон: 5..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Syslog-port"></a> [port](#keyapis-preset-v1-Preset-Syslog-port) | Порт. # Диапазон: 1..65536 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-Syslog-protocol_type"></a> [protocol_type](#keyapis-preset-v1-Preset-Syslog-protocol_type) | Протокол |    [keyapis.preset.v1.Preset.Syslog.ProtocolType](#keyapis-preset-v1-Preset-Syslog-ProtocolType) | REQUIRED|






<a name="keyapis-preset-v1-Preset-VideoConfig"></a>


### [Preset.VideoConfig](#keyapis-preset-v1-Preset-VideoConfig)
 Параметры конфигурации видео


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-VideoConfig-quality_type"></a> [quality_type](#keyapis-preset-v1-Preset-VideoConfig-quality_type) | Тип пресета |    [keyapis.preset.v1.Preset.VideoConfig.QualityType](#keyapis-preset-v1-Preset-VideoConfig-QualityType) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-VideoConfig-rtsp_user"></a> [rtsp_user](#keyapis-preset-v1-Preset-VideoConfig-rtsp_user) | Пользователь |    [keyapis.preset.v1.Preset.VideoConfig.RtspUser](#keyapis-preset-v1-Preset-VideoConfig-RtspUser) | REQUIRED|






<a name="keyapis-preset-v1-Preset-VideoConfig-RtspUser"></a>


### [Preset.VideoConfig.RtspUser](#keyapis-preset-v1-Preset-VideoConfig-RtspUser)
 Пользователь


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-Preset-VideoConfig-RtspUser-username"></a> [username](#keyapis-preset-v1-Preset-VideoConfig-RtspUser-username) | Имя пользователя. # Диапазон: 3..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-Preset-VideoConfig-RtspUser-password"></a> [password](#keyapis-preset-v1-Preset-VideoConfig-RtspUser-password) | Пароль. # Диапазон: 3..256 |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-preset-v1-PresetFilter"></a>


### [PresetFilter](#keyapis-preset-v1-PresetFilter)
 Фильтр по пресетам


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PresetFilter-mrf_ids"></a> [mrf_ids](#keyapis-preset-v1-PresetFilter-mrf_ids) | По идентификаторам МРФ |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-preset-v1-PresetFilter-rf_ids"></a> [rf_ids](#keyapis-preset-v1-PresetFilter-rf_ids) | По идентификаторам РФ |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-preset-v1-PresetFilter-text"></a> [text](#keyapis-preset-v1-PresetFilter-text) | Поиск по тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование; # - Описание |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OPTIONAL|
| <a id="keyapis-preset-v1-PresetFilter-title"></a> [title](#keyapis-preset-v1-PresetFilter-title) | Поиск по наименованию. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OPTIONAL|
| <a id="keyapis-preset-v1-PresetFilter-status_types"></a> [status_types](#keyapis-preset-v1-PresetFilter-status_types) | По статусам |  repeated  [keyapis.preset.v1.Preset.StatusType](#keyapis-preset-v1-Preset-StatusType) | OPTIONAL|






<a name="keyapis-preset-v1-PresetPaging"></a>


### [PresetPaging](#keyapis-preset-v1-PresetPaging)
 Постраничный вывод


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-PresetPaging-order_by_type"></a> [order_by_type](#keyapis-preset-v1-PresetPaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CHANGED_AT |    [keyapis.preset.v1.PresetPaging.OrderByType](#keyapis-preset-v1-PresetPaging-OrderByType) | <nil>|
| <a id="keyapis-preset-v1-PresetPaging-direction_type"></a> [direction_type](#keyapis-preset-v1-PresetPaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC |    [keyapis.preset.v1.PresetPaging.DirectionType](#keyapis-preset-v1-PresetPaging-DirectionType) | <nil>|
| <a id="keyapis-preset-v1-PresetPaging-limit"></a> [limit](#keyapis-preset-v1-PresetPaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-preset-v1-PresetPaging-offset"></a> [offset](#keyapis-preset-v1-PresetPaging-offset) | Сдвиг. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-preset-v1-ValidationError"></a>


### [ValidationError](#keyapis-preset-v1-ValidationError)
 Ошибки валидации.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-preset-v1-ValidationError-path"></a> [path](#keyapis-preset-v1-ValidationError-path) | Путь к полю в формате наименования прото |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-preset-v1-ValidationError-message"></a> [message](#keyapis-preset-v1-ValidationError-message) | Валидационное сообщение |    [string](#scalar-types) | REQUIRED|





 <!-- end messages -->



<a name="keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType"></a>

### [Preset.FaceRecognition.ConfigurationType](#keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType)
 Тип конфигурации

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType-CONFIGURATION_TYPE_UNKNOWN"></a> [CONFIGURATION_TYPE_UNKNOWN](#keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType-CONFIGURATION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType-DEFAULT"></a> [DEFAULT](#keyapis-preset-v1-Preset-FaceRecognition-ConfigurationType-DEFAULT) | По умолчанию |




<a name="keyapis-preset-v1-Preset-StatusType"></a>

### [Preset.StatusType](#keyapis-preset-v1-Preset-StatusType)
 Справочник статусов.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-preset-v1-Preset-StatusType-STATUS_TYPE_UNKNOWN"></a> [STATUS_TYPE_UNKNOWN](#keyapis-preset-v1-Preset-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-preset-v1-Preset-StatusType-ACTIVE"></a> [ACTIVE](#keyapis-preset-v1-Preset-StatusType-ACTIVE) | Активный |
| 2 | <a id="keyapis-preset-v1-Preset-StatusType-ARCHIVE"></a> [ARCHIVE](#keyapis-preset-v1-Preset-StatusType-ARCHIVE) | Архивный |




<a name="keyapis-preset-v1-Preset-Syslog-ProtocolType"></a>

### [Preset.Syslog.ProtocolType](#keyapis-preset-v1-Preset-Syslog-ProtocolType)
 Тип протокола.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-preset-v1-Preset-Syslog-ProtocolType-PROTOCOL_TYPE_UNKNOWN"></a> [PROTOCOL_TYPE_UNKNOWN](#keyapis-preset-v1-Preset-Syslog-ProtocolType-PROTOCOL_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-preset-v1-Preset-Syslog-ProtocolType-UDP"></a> [UDP](#keyapis-preset-v1-Preset-Syslog-ProtocolType-UDP) | Протокол UDP |
| 2 | <a id="keyapis-preset-v1-Preset-Syslog-ProtocolType-TCP"></a> [TCP](#keyapis-preset-v1-Preset-Syslog-ProtocolType-TCP) | Протокол TCP |




<a name="keyapis-preset-v1-Preset-VideoConfig-QualityType"></a>

### [Preset.VideoConfig.QualityType](#keyapis-preset-v1-Preset-VideoConfig-QualityType)
 Справочник качеств.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-preset-v1-Preset-VideoConfig-QualityType-QUALITY_TYPE_UNKNOWN"></a> [QUALITY_TYPE_UNKNOWN](#keyapis-preset-v1-Preset-VideoConfig-QualityType-QUALITY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-preset-v1-Preset-VideoConfig-QualityType-HIGH"></a> [HIGH](#keyapis-preset-v1-Preset-VideoConfig-QualityType-HIGH) | Высокое качество |
| 2 | <a id="keyapis-preset-v1-Preset-VideoConfig-QualityType-MEDIUM"></a> [MEDIUM](#keyapis-preset-v1-Preset-VideoConfig-QualityType-MEDIUM) | Среднее качество |




<a name="keyapis-preset-v1-PresetPaging-DirectionType"></a>

### [PresetPaging.DirectionType](#keyapis-preset-v1-PresetPaging-DirectionType)
 Справочник типов направлений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-preset-v1-PresetPaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-preset-v1-PresetPaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-preset-v1-PresetPaging-DirectionType-DESC"></a> [DESC](#keyapis-preset-v1-PresetPaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-preset-v1-PresetPaging-DirectionType-ASC"></a> [ASC](#keyapis-preset-v1-PresetPaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-preset-v1-PresetPaging-OrderByType"></a>

### [PresetPaging.OrderByType](#keyapis-preset-v1-PresetPaging-OrderByType)
 Справочник типов значений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-preset-v1-PresetPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-preset-v1-PresetPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-preset-v1-PresetPaging-OrderByType-ID"></a> [ID](#keyapis-preset-v1-PresetPaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-preset-v1-PresetPaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-preset-v1-PresetPaging-OrderByType-CREATED_AT) | По времени создания |
| 3 | <a id="keyapis-preset-v1-PresetPaging-OrderByType-CHANGED_AT"></a> [CHANGED_AT](#keyapis-preset-v1-PresetPaging-OrderByType-CHANGED_AT) | По времени изменения |
| 4 | <a id="keyapis-preset-v1-PresetPaging-OrderByType-RANK"></a> [RANK](#keyapis-preset-v1-PresetPaging-OrderByType-RANK) | По рангу для поиска по тексту. Применяется когда передано поле для поиска по тексту. В случае если текстовое поле не передано, применяется значение по умолчанию |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |