# Протокол

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

- [keyapis/access_control/v1/keyapis_access_control_access_zone_v1.proto](#keyapis_access_control_v1_keyapis_access_control_access_zone_v1-proto)
    - [AccessZoneService](#keyapis-access_control-v1-AccessZoneService)
  
    - [AccessZone](#keyapis-access_control-v1-AccessZone)
    - [AccessZone.SavingError](#keyapis-access_control-v1-AccessZone-SavingError)
    - [AccessZone.SavingError.AccessPointFlatgrammMismatch](#keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch)
    - [AccessZone.SavingError.Conflict](#keyapis-access_control-v1-AccessZone-SavingError-Conflict)
    - [AccessZoneFilter](#keyapis-access_control-v1-AccessZoneFilter)
    - [AccessZonePaging](#keyapis-access_control-v1-AccessZonePaging)
    - [DeleteAccessZoneRequest](#keyapis-access_control-v1-DeleteAccessZoneRequest)
    - [DeleteAccessZoneResponse](#keyapis-access_control-v1-DeleteAccessZoneResponse)
    - [DeleteAccessZoneResponse.Error](#keyapis-access_control-v1-DeleteAccessZoneResponse-Error)
    - [GetAccessZoneCountRequest](#keyapis-access_control-v1-GetAccessZoneCountRequest)
    - [GetAccessZoneCountResponse](#keyapis-access_control-v1-GetAccessZoneCountResponse)
    - [GetAccessZoneCountResponse.Error](#keyapis-access_control-v1-GetAccessZoneCountResponse-Error)
    - [GetAccessZoneListRequest](#keyapis-access_control-v1-GetAccessZoneListRequest)
    - [GetAccessZoneListResponse](#keyapis-access_control-v1-GetAccessZoneListResponse)
    - [GetAccessZoneListResponse.Error](#keyapis-access_control-v1-GetAccessZoneListResponse-Error)
    - [GetAccessZoneRequest](#keyapis-access_control-v1-GetAccessZoneRequest)
    - [GetAccessZoneResponse](#keyapis-access_control-v1-GetAccessZoneResponse)
    - [GetAccessZoneResponse.Error](#keyapis-access_control-v1-GetAccessZoneResponse-Error)
    - [PostAccessZoneRequest](#keyapis-access_control-v1-PostAccessZoneRequest)
    - [PostAccessZoneResponse](#keyapis-access_control-v1-PostAccessZoneResponse)
    - [PostAccessZoneResponse.Error](#keyapis-access_control-v1-PostAccessZoneResponse-Error)
    - [PostAccessZoneRestoreRequest](#keyapis-access_control-v1-PostAccessZoneRestoreRequest)
    - [PostAccessZoneRestoreResponse](#keyapis-access_control-v1-PostAccessZoneRestoreResponse)
    - [PostAccessZoneRestoreResponse.Error](#keyapis-access_control-v1-PostAccessZoneRestoreResponse-Error)
  
    - [AccessZonePaging.DirectionType](#keyapis-access_control-v1-AccessZonePaging-DirectionType)
    - [AccessZonePaging.OrderByType](#keyapis-access_control-v1-AccessZonePaging-OrderByType)
  


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




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

## [keyapis/access_control/v1/keyapis_access_control_access_zone_v1.proto](/protos/key/keyapis/access_control/v1/keyapis_access_control_access_zone_v1.proto)
Сервис реализует функционал управления зонами доступа


<a name="keyapis-access_control-v1-AccessZoneService"></a>

### AccessZoneService
 Сервис зон доступа

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-access_control-v1-PostAccessZone"></a> [PostAccessZone](#keyapis-access_control-v1-PostAccessZone) | Метод сохранения зоны доступа. Поддерживает создание и обновление. Для пользователей типов owner, employee можно создать и редактировать зону доступа только в квартирограмме, относящейся к компании пользователя. Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee | [keyapis.access_control.v1.PostAccessZoneRequest](#keyapis-access_control-v1-PostAccessZoneRequest) | [keyapis.access_control.v1.PostAccessZoneResponse](#keyapis-access_control-v1-PostAccessZoneResponse) |
| <a id="keyapis-access_control-v1-GetAccessZone"></a> [GetAccessZone](#keyapis-access_control-v1-GetAccessZone) | Метод получения зоны доступа по идентификатору. Для пользователей типов owner, employee возвращаются только зоны доступа, относящиеся к компании пользователя. Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee | [keyapis.access_control.v1.GetAccessZoneRequest](#keyapis-access_control-v1-GetAccessZoneRequest) | [keyapis.access_control.v1.GetAccessZoneResponse](#keyapis-access_control-v1-GetAccessZoneResponse) |
| <a id="keyapis-access_control-v1-GetAccessZoneList"></a> [GetAccessZoneList](#keyapis-access_control-v1-GetAccessZoneList) | Метод получения списка зон доступа. Для пользователей типов owner, employee возвращаются только зоны доступа, относящиеся к компании пользователя. Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee | [keyapis.access_control.v1.GetAccessZoneListRequest](#keyapis-access_control-v1-GetAccessZoneListRequest) | [keyapis.access_control.v1.GetAccessZoneListResponse](#keyapis-access_control-v1-GetAccessZoneListResponse) stream |
| <a id="keyapis-access_control-v1-GetAccessZoneCount"></a> [GetAccessZoneCount](#keyapis-access_control-v1-GetAccessZoneCount) | Метод получения количества зон доступа. Для пользователей типов owner, employee возвращаются только зоны доступа, относящиеся к компании пользователя. Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee | [keyapis.access_control.v1.GetAccessZoneCountRequest](#keyapis-access_control-v1-GetAccessZoneCountRequest) | [keyapis.access_control.v1.GetAccessZoneCountResponse](#keyapis-access_control-v1-GetAccessZoneCountResponse) |
| <a id="keyapis-access_control-v1-DeleteAccessZone"></a> [DeleteAccessZone](#keyapis-access_control-v1-DeleteAccessZone) | Метод архивации зоны доступа. Для пользователей типов owner, employee доступны к архивации только зоны доступа, относящиеся к компании пользователя. Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee | [keyapis.access_control.v1.DeleteAccessZoneRequest](#keyapis-access_control-v1-DeleteAccessZoneRequest) | [keyapis.access_control.v1.DeleteAccessZoneResponse](#keyapis-access_control-v1-DeleteAccessZoneResponse) |
| <a id="keyapis-access_control-v1-PostAccessZoneRestore"></a> [PostAccessZoneRestore](#keyapis-access_control-v1-PostAccessZoneRestore) | Метод разархивации зоны доступа по идентификатору. Для пользователей типов owner, employee доступны к разархивации только зоны доступа, относящиеся к компании пользователя. Метод доступен для: admin, service, bti, ltp_first, device_admin, manager, owner, employee | [keyapis.access_control.v1.PostAccessZoneRestoreRequest](#keyapis-access_control-v1-PostAccessZoneRestoreRequest) | [keyapis.access_control.v1.PostAccessZoneRestoreResponse](#keyapis-access_control-v1-PostAccessZoneRestoreResponse) |

 <!-- end services -->


<a name="keyapis-access_control-v1-AccessZone"></a>


### [AccessZone](#keyapis-access_control-v1-AccessZone)
 Зона доступа.
# Описание модели


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-AccessZone-id"></a> [id](#keyapis-access_control-v1-AccessZone-id) | Идентификатор зоны доступа. # Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-AccessZone-title"></a> [title](#keyapis-access_control-v1-AccessZone-title) | Наименование. # Диапазон: 3..64 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-AccessZone-description"></a> [description](#keyapis-access_control-v1-AccessZone-description) | Описание. # Диапазон: 3..200 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-AccessZone-flatgramm_id"></a> [flatgramm_id](#keyapis-access_control-v1-AccessZone-flatgramm_id) | Идентификатор квартирограммы. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-AccessZone-created_at"></a> [created_at](#keyapis-access_control-v1-AccessZone-created_at) | Дата создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-access_control-v1-AccessZone-changed_at"></a> [changed_at](#keyapis-access_control-v1-AccessZone-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-AccessZone-deleted_at"></a> [deleted_at](#keyapis-access_control-v1-AccessZone-deleted_at) | Дата удаления. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-access_control-v1-AccessZone-access_point_ids"></a> [access_point_ids](#keyapis-access_control-v1-AccessZone-access_point_ids) | Идентификаторы точек доступа, входящих в зону. Все точки доступа должны принадлежать той же квартирограмме, что и зона. # Тип: Guid. # Диапазон: 0..1000 |  repeated  [string](#scalar-types) | <nil>|






<a name="keyapis-access_control-v1-AccessZone-SavingError"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-AccessZone-SavingError-conflict"></a> [conflict](#keyapis-access_control-v1-AccessZone-SavingError-conflict) | Конфликт версий |  optional  [keyapis.access_control.v1.AccessZone.SavingError.Conflict](#keyapis-access_control-v1-AccessZone-SavingError-Conflict) | <nil>|
| <a id="keyapis-access_control-v1-AccessZone-SavingError-access_point_flatgramm_mismatch"></a> [access_point_flatgramm_mismatch](#keyapis-access_control-v1-AccessZone-SavingError-access_point_flatgramm_mismatch) | Точка доступа принадлежит другой квартирограмме |  optional  [keyapis.access_control.v1.AccessZone.SavingError.AccessPointFlatgrammMismatch](#keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch) | <nil>|






<a name="keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch"></a>


### [AccessZone.SavingError.AccessPointFlatgrammMismatch](#keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch)
 Несовпадение квартирограммы точки доступа.
Причины:
- Точка доступа принадлежит другой квартирограмме — её flatgramm_id не совпадает с flatgramm_id зоны доступа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch-access_point_id"></a> [access_point_id](#keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch-access_point_id) | Идентификатор точки доступа с несовпадающей квартирограммой. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch-access_point_flatgramm_id"></a> [access_point_flatgramm_id](#keyapis-access_control-v1-AccessZone-SavingError-AccessPointFlatgrammMismatch-access_point_flatgramm_id) | Идентификатор квартирограммы точки доступа. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-access_control-v1-AccessZone-SavingError-Conflict"></a>


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






<a name="keyapis-access_control-v1-AccessZoneFilter"></a>


### [AccessZoneFilter](#keyapis-access_control-v1-AccessZoneFilter)
 Фильтр по зонам доступа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-AccessZoneFilter-text"></a> [text](#keyapis-access_control-v1-AccessZoneFilter-text) | По тексту. Если значение не передано, поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование; # - Описание |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-AccessZoneFilter-flatgramm_ids"></a> [flatgramm_ids](#keyapis-access_control-v1-AccessZoneFilter-flatgramm_ids) | По идентификаторам квартирограмм |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-AccessZoneFilter-show_deleted"></a> [show_deleted](#keyapis-access_control-v1-AccessZoneFilter-show_deleted) | Включать удалённые записи. Если не передано — удалённые записи не включаются |    [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-access_control-v1-AccessZonePaging"></a>


### [AccessZonePaging](#keyapis-access_control-v1-AccessZonePaging)
 Постраничный вывод зон доступа


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






<a name="keyapis-access_control-v1-DeleteAccessZoneRequest"></a>


### [DeleteAccessZoneRequest](#keyapis-access_control-v1-DeleteAccessZoneRequest)
 Запрос удаления зоны доступа


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






<a name="keyapis-access_control-v1-DeleteAccessZoneResponse"></a>


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


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






<a name="keyapis-access_control-v1-DeleteAccessZoneResponse-Error"></a>


### [DeleteAccessZoneResponse.Error](#keyapis-access_control-v1-DeleteAccessZoneResponse-Error)
 Ошибка запроса удаления зоны доступа


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






<a name="keyapis-access_control-v1-GetAccessZoneCountRequest"></a>


### [GetAccessZoneCountRequest](#keyapis-access_control-v1-GetAccessZoneCountRequest)
 Запрос на получение количества зон доступа


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






<a name="keyapis-access_control-v1-GetAccessZoneCountResponse"></a>


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


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






<a name="keyapis-access_control-v1-GetAccessZoneCountResponse-Error"></a>


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


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






<a name="keyapis-access_control-v1-GetAccessZoneListRequest"></a>


### [GetAccessZoneListRequest](#keyapis-access_control-v1-GetAccessZoneListRequest)
 Запрос на получение списка зон доступа


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






<a name="keyapis-access_control-v1-GetAccessZoneListResponse"></a>


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


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






<a name="keyapis-access_control-v1-GetAccessZoneListResponse-Error"></a>


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


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






<a name="keyapis-access_control-v1-GetAccessZoneRequest"></a>


### [GetAccessZoneRequest](#keyapis-access_control-v1-GetAccessZoneRequest)
 Запрос на получение зоны доступа по идентификатору


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






<a name="keyapis-access_control-v1-GetAccessZoneResponse"></a>


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


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






<a name="keyapis-access_control-v1-GetAccessZoneResponse-Error"></a>


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


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






<a name="keyapis-access_control-v1-PostAccessZoneRequest"></a>


### [PostAccessZoneRequest](#keyapis-access_control-v1-PostAccessZoneRequest)
 Запрос на создание/изменение зоны доступа


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-PostAccessZoneRequest-data"></a> [data](#keyapis-access_control-v1-PostAccessZoneRequest-data) | Зона доступа |    [keyapis.access_control.v1.AccessZone](#keyapis-access_control-v1-AccessZone) | REQUIRED|






<a name="keyapis-access_control-v1-PostAccessZoneResponse"></a>


### [PostAccessZoneResponse](#keyapis-access_control-v1-PostAccessZoneResponse)
 Ответ на запрос на создание/изменение зоны доступа


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






<a name="keyapis-access_control-v1-PostAccessZoneResponse-Error"></a>


### [PostAccessZoneResponse.Error](#keyapis-access_control-v1-PostAccessZoneResponse-Error)
 Ошибка запроса сохранения зоны доступа


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






<a name="keyapis-access_control-v1-PostAccessZoneRestoreRequest"></a>


### [PostAccessZoneRestoreRequest](#keyapis-access_control-v1-PostAccessZoneRestoreRequest)
 Запрос разархивации зоны доступа по идентификатору


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






<a name="keyapis-access_control-v1-PostAccessZoneRestoreResponse"></a>


### [PostAccessZoneRestoreResponse](#keyapis-access_control-v1-PostAccessZoneRestoreResponse)
 Ответ на запрос разархивации зоны доступа


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






<a name="keyapis-access_control-v1-PostAccessZoneRestoreResponse-Error"></a>


### [PostAccessZoneRestoreResponse.Error](#keyapis-access_control-v1-PostAccessZoneRestoreResponse-Error)
 Ошибка запроса разархивации зоны доступа


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





 <!-- end messages -->



<a name="keyapis-access_control-v1-AccessZonePaging-DirectionType"></a>

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

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




<a name="keyapis-access_control-v1-AccessZonePaging-OrderByType"></a>

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-AccessZonePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_control-v1-AccessZonePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-AccessZonePaging-OrderByType-ID"></a> [ID](#keyapis-access_control-v1-AccessZonePaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-access_control-v1-AccessZonePaging-OrderByType-TITLE"></a> [TITLE](#keyapis-access_control-v1-AccessZonePaging-OrderByType-TITLE) | По наименованию |
| 3 | <a id="keyapis-access_control-v1-AccessZonePaging-OrderByType-CHANGED_AT"></a> [CHANGED_AT](#keyapis-access_control-v1-AccessZonePaging-OrderByType-CHANGED_AT) | Дата последнего изменения |
| 4 | <a id="keyapis-access_control-v1-AccessZonePaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-access_control-v1-AccessZonePaging-OrderByType-CREATED_AT) | Дата создания |
| 5 | <a id="keyapis-access_control-v1-AccessZonePaging-OrderByType-RANK"></a> [RANK](#keyapis-access_control-v1-AccessZonePaging-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 |