# Протокол

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

- [keyapis/access_control/v1/keyapis_access_control_entrance_v1.proto](#keyapis_access_control_v1_keyapis_access_control_entrance_v1-proto)
    - [EntranceService](#keyapis-access_control-v1-EntranceService)
  
    - [DeleteEntranceRequest](#keyapis-access_control-v1-DeleteEntranceRequest)
    - [DeleteEntranceResponse](#keyapis-access_control-v1-DeleteEntranceResponse)
    - [DeleteEntranceResponse.Error](#keyapis-access_control-v1-DeleteEntranceResponse-Error)
    - [DeleteEntranceResponse.Error.LinkedDevicesExists](#keyapis-access_control-v1-DeleteEntranceResponse-Error-LinkedDevicesExists)
    - [Entrance](#keyapis-access_control-v1-Entrance)
    - [EntranceDevice](#keyapis-access_control-v1-EntranceDevice)
    - [EntranceDeviceFilter](#keyapis-access_control-v1-EntranceDeviceFilter)
    - [EntranceDevicePaging](#keyapis-access_control-v1-EntranceDevicePaging)
    - [EntranceFilter](#keyapis-access_control-v1-EntranceFilter)
    - [EntrancePaging](#keyapis-access_control-v1-EntrancePaging)
    - [GetEntranceDeviceListRequest](#keyapis-access_control-v1-GetEntranceDeviceListRequest)
    - [GetEntranceDeviceListResponse](#keyapis-access_control-v1-GetEntranceDeviceListResponse)
    - [GetEntranceDeviceListResponse.Error](#keyapis-access_control-v1-GetEntranceDeviceListResponse-Error)
    - [GetEntranceListRequest](#keyapis-access_control-v1-GetEntranceListRequest)
    - [GetEntranceListResponse](#keyapis-access_control-v1-GetEntranceListResponse)
    - [GetEntranceListResponse.Error](#keyapis-access_control-v1-GetEntranceListResponse-Error)
    - [PostEntranceRequest](#keyapis-access_control-v1-PostEntranceRequest)
    - [PostEntranceResponse](#keyapis-access_control-v1-PostEntranceResponse)
    - [PostEntranceResponse.Error](#keyapis-access_control-v1-PostEntranceResponse-Error)
    - [PutEntranceDeviceAttachRequest](#keyapis-access_control-v1-PutEntranceDeviceAttachRequest)
    - [PutEntranceDeviceAttachResponse](#keyapis-access_control-v1-PutEntranceDeviceAttachResponse)
    - [PutEntranceDeviceAttachResponse.Error](#keyapis-access_control-v1-PutEntranceDeviceAttachResponse-Error)
    - [PutEntranceDeviceDetachRequest](#keyapis-access_control-v1-PutEntranceDeviceDetachRequest)
    - [PutEntranceDeviceDetachResponse](#keyapis-access_control-v1-PutEntranceDeviceDetachResponse)
    - [PutEntranceDeviceDetachResponse.Error](#keyapis-access_control-v1-PutEntranceDeviceDetachResponse-Error)
  
    - [EntranceDevice.RelationType](#keyapis-access_control-v1-EntranceDevice-RelationType)
    - [EntranceDevicePaging.DirectionType](#keyapis-access_control-v1-EntranceDevicePaging-DirectionType)
    - [EntranceDevicePaging.OrderByType](#keyapis-access_control-v1-EntranceDevicePaging-OrderByType)
    - [EntranceFilter.CompanyRelationType](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType)
    - [EntrancePaging.DirectionType](#keyapis-access_control-v1-EntrancePaging-DirectionType)
    - [EntrancePaging.OrderByType](#keyapis-access_control-v1-EntrancePaging-OrderByType)
  


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




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

## [keyapis/access_control/v1/keyapis_access_control_entrance_v1.proto](/protos/key/keyapis/access_control/v1/keyapis_access_control_entrance_v1.proto)
Сервис подъездов


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

### EntranceService
 Сервис подъездов

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-access_control-v1-PostEntrance"></a> [PostEntrance](#keyapis-access_control-v1-PostEntrance) | Метод создания подъезда. Для ролей employee, owner можно сохранять только подъезды квартирограмм, привязанные к домофонной компании пользователя (привязка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE). Метод доступен для: admin, service, owner, employee | [keyapis.access_control.v1.PostEntranceRequest](#keyapis-access_control-v1-PostEntranceRequest) | [keyapis.access_control.v1.PostEntranceResponse](#keyapis-access_control-v1-PostEntranceResponse) |
| <a id="keyapis-access_control-v1-DeleteEntrance"></a> [DeleteEntrance](#keyapis-access_control-v1-DeleteEntrance) | Метод удаления подъезда. Реализуется как удаление квартир по указанному дому и номеру подъезда. Для ролей employee, owner можно удалять только подъезды квартирограмм, привязанные к домофонной компании пользователя (привязка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE). Метод доступен для: admin, service, owner, employee | [keyapis.access_control.v1.DeleteEntranceRequest](#keyapis-access_control-v1-DeleteEntranceRequest) | [keyapis.access_control.v1.DeleteEntranceResponse](#keyapis-access_control-v1-DeleteEntranceResponse) |
| <a id="keyapis-access_control-v1-GetEntranceList"></a> [GetEntranceList](#keyapis-access_control-v1-GetEntranceList) | Метод получения списка подъездов. При переданном company_ids учитывается тип связи компании и квартирограммы. Если EntranceFilter.CompanyRelationType = DEVICE_SERVICE, то проверяется связка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE. Если EntranceFilter.CompanyRelationType = MANAGEMENT, то проверяется связка в flatgramm_companies. Если EntranceFilter.CompanyRelationType = DEFAULT, то проверяется связка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE. Если EntranceFilter.CompanyRelationType = COMPANY_RELATION_TYPE_UNKNOWN, вернется ошибка валидации. При не переданном company_ids поле EntranceFilter.CompanyRelationType вызовет ошибку валидации. Для ролей employee, owner можно получать только подъезды квартирограмм, привязанные к домофонной компании пользователя (привязка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE). Метод доступен для: admin, service, owner, employee | [keyapis.access_control.v1.GetEntranceListRequest](#keyapis-access_control-v1-GetEntranceListRequest) | [keyapis.access_control.v1.GetEntranceListResponse](#keyapis-access_control-v1-GetEntranceListResponse) stream |
| <a id="keyapis-access_control-v1-PutEntranceDeviceAttach"></a> [PutEntranceDeviceAttach](#keyapis-access_control-v1-PutEntranceDeviceAttach) | Метод создания связи подъезда и устройства. Для ролей employee, owner можно сохранять только связи с подъездами квартирограмм, привязанным к домофонной компании пользователя (привязка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE). EntranceDevice.RelationType в данном методе не используется. Метод доступен для: admin, service, owner, employee | [keyapis.access_control.v1.PutEntranceDeviceAttachRequest](#keyapis-access_control-v1-PutEntranceDeviceAttachRequest) | [keyapis.access_control.v1.PutEntranceDeviceAttachResponse](#keyapis-access_control-v1-PutEntranceDeviceAttachResponse) |
| <a id="keyapis-access_control-v1-PutEntranceDeviceDetach"></a> [PutEntranceDeviceDetach](#keyapis-access_control-v1-PutEntranceDeviceDetach) | Метод удаления связи подъезда и устройства. Для ролей employee, owner можно удалять только связи с подъездами квартирограмм, привязанным к домофонной компании пользователя (привязка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE). EntranceDevice.RelationType в данном методе не используется. Метод доступен для: admin, service, owner, employee | [keyapis.access_control.v1.PutEntranceDeviceDetachRequest](#keyapis-access_control-v1-PutEntranceDeviceDetachRequest) | [keyapis.access_control.v1.PutEntranceDeviceDetachResponse](#keyapis-access_control-v1-PutEntranceDeviceDetachResponse) |
| <a id="keyapis-access_control-v1-GetEntranceDeviceList"></a> [GetEntranceDeviceList](#keyapis-access_control-v1-GetEntranceDeviceList) | Метод получения списка связок подъезд-устройство. Для ролей employee, owner можно получать только связи с подъездами квартирограмм, привязанным к домофонной компании пользователя (привязка компании с типом dc_company_flatgramm.type = DEVICE_SERVICE). Метод доступен для: admin, service, owner, employee | [keyapis.access_control.v1.GetEntranceDeviceListRequest](#keyapis-access_control-v1-GetEntranceDeviceListRequest) | [keyapis.access_control.v1.GetEntranceDeviceListResponse](#keyapis-access_control-v1-GetEntranceDeviceListResponse) stream |

 <!-- end services -->


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


### [DeleteEntranceRequest](#keyapis-access_control-v1-DeleteEntranceRequest)
 Запрос на удаление подъезда


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-DeleteEntranceRequest-orpon"></a> [orpon](#keyapis-access_control-v1-DeleteEntranceRequest-orpon) | ОРПОН дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-DeleteEntranceRequest-entrance_number"></a> [entrance_number](#keyapis-access_control-v1-DeleteEntranceRequest-entrance_number) | Номер подъезда. # Диапазон: 1..100 |    [int32](#scalar-types) | REQUIRED|






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


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


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






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


### [DeleteEntranceResponse.Error](#keyapis-access_control-v1-DeleteEntranceResponse-Error)
 Ошибка удаления подъезда


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-DeleteEntranceResponse-Error-validation"></a> [validation](#keyapis-access_control-v1-DeleteEntranceResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.access_control.v1.ValidationError](#keyapis-access_control-v1-ValidationError) | <nil>|
| <a id="keyapis-access_control-v1-DeleteEntranceResponse-Error-linked_devices_exists"></a> [linked_devices_exists](#keyapis-access_control-v1-DeleteEntranceResponse-Error-linked_devices_exists) | Существуют связанные устройства |  optional  [keyapis.access_control.v1.DeleteEntranceResponse.Error.LinkedDevicesExists](#keyapis-access_control-v1-DeleteEntranceResponse-Error-LinkedDevicesExists) | <nil>|






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


### [DeleteEntranceResponse.Error.LinkedDevicesExists](#keyapis-access_control-v1-DeleteEntranceResponse-Error-LinkedDevicesExists)
 Существуют устройства, связанные с квартирами данного подъезда.
Следует отвязать устройства перед удалением подъезда






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


### [Entrance](#keyapis-access_control-v1-Entrance)
 Подъезд


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-Entrance-orpon"></a> [orpon](#keyapis-access_control-v1-Entrance-orpon) | ОРПОН дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-Entrance-entrance_number"></a> [entrance_number](#keyapis-access_control-v1-Entrance-entrance_number) | Номер подъезда. # Диапазон: 1..100 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-Entrance-start_room_number"></a> [start_room_number](#keyapis-access_control-v1-Entrance-start_room_number) | Номер начального помещения. # Диапазон: 1..9999 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-Entrance-rooms_count_per_floor"></a> [rooms_count_per_floor](#keyapis-access_control-v1-Entrance-rooms_count_per_floor) | Количество помещений на этаже. # Диапазон: 1..1000 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-Entrance-floors_count"></a> [floors_count](#keyapis-access_control-v1-Entrance-floors_count) | Количество этажей. # Диапазон: 1..100 |    [int32](#scalar-types) | REQUIRED|






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


### [EntranceDevice](#keyapis-access_control-v1-EntranceDevice)
 Связка подъезда и устройства.
Реализуется через связь всех помещений в подъезде и устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-EntranceDevice-orpon"></a> [orpon](#keyapis-access_control-v1-EntranceDevice-orpon) | ОРПОН дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-EntranceDevice-entrance_number"></a> [entrance_number](#keyapis-access_control-v1-EntranceDevice-entrance_number) | Номер подъезда. # Диапазон: 1..100 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-EntranceDevice-device_id"></a> [device_id](#keyapis-access_control-v1-EntranceDevice-device_id) | Идентификатор устройства. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-EntranceDevice-relation_type"></a> [relation_type](#keyapis-access_control-v1-EntranceDevice-relation_type) | Тип связки. Игнорируется в методах создания и удаления связи |    [keyapis.access_control.v1.EntranceDevice.RelationType](#keyapis-access_control-v1-EntranceDevice-RelationType) | OUTPUT_ONLY|






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


### [EntranceDeviceFilter](#keyapis-access_control-v1-EntranceDeviceFilter)
 Фильтр связок подъезд-устройство


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-EntranceDeviceFilter-flatgramm_ids"></a> [flatgramm_ids](#keyapis-access_control-v1-EntranceDeviceFilter-flatgramm_ids) | По идентификаторам квартирограмм |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-EntranceDeviceFilter-orpons"></a> [orpons](#keyapis-access_control-v1-EntranceDeviceFilter-orpons) | По ОРПОН |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-EntranceDeviceFilter-entrance_numbers"></a> [entrance_numbers](#keyapis-access_control-v1-EntranceDeviceFilter-entrance_numbers) | По номерам подъезда |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-EntranceDeviceFilter-device_ids"></a> [device_ids](#keyapis-access_control-v1-EntranceDeviceFilter-device_ids) | По идентификаторам привязанных устройств |  repeated  [int32](#scalar-types) | <nil>|






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


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


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






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


### [EntranceFilter](#keyapis-access_control-v1-EntranceFilter)
 Фильтр подъездов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-EntranceFilter-flatgramm_ids"></a> [flatgramm_ids](#keyapis-access_control-v1-EntranceFilter-flatgramm_ids) | По идентификаторам квартирограмм |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-EntranceFilter-orpons"></a> [orpons](#keyapis-access_control-v1-EntranceFilter-orpons) | По ОРПОН |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-EntranceFilter-company_ids"></a> [company_ids](#keyapis-access_control-v1-EntranceFilter-company_ids) | По идентификаторам компаний |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-EntranceFilter-company_relation_type"></a> [company_relation_type](#keyapis-access_control-v1-EntranceFilter-company_relation_type) | Тип связи компании с подъездами |    [keyapis.access_control.v1.EntranceFilter.CompanyRelationType](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType) | <nil>|






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


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


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






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


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


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






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


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


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






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


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


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






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


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


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






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


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


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






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


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


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






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


### [PostEntranceRequest](#keyapis-access_control-v1-PostEntranceRequest)
 Запрос сохранения подъезда


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






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


### [PostEntranceResponse](#keyapis-access_control-v1-PostEntranceResponse)
 Ответ на запрос сохранения подъезда


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






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


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


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






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


### [PutEntranceDeviceAttachRequest](#keyapis-access_control-v1-PutEntranceDeviceAttachRequest)
 Запрос создания связи подъезда и устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-PutEntranceDeviceAttachRequest-entrance_device"></a> [entrance_device](#keyapis-access_control-v1-PutEntranceDeviceAttachRequest-entrance_device) | Связь подъезда и устройства |    [keyapis.access_control.v1.EntranceDevice](#keyapis-access_control-v1-EntranceDevice) | REQUIRED|






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


### [PutEntranceDeviceAttachResponse](#keyapis-access_control-v1-PutEntranceDeviceAttachResponse)
 Ответ на запрос сохранения связи подъезда и устройства


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






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


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


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






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-PutEntranceDeviceDetachRequest-entrance_device"></a> [entrance_device](#keyapis-access_control-v1-PutEntranceDeviceDetachRequest-entrance_device) | Связь подъезда и устройства |    [keyapis.access_control.v1.EntranceDevice](#keyapis-access_control-v1-EntranceDevice) | REQUIRED|






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


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


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






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


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


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





 <!-- end messages -->



<a name="keyapis-access_control-v1-EntranceDevice-RelationType"></a>

### [EntranceDevice.RelationType](#keyapis-access_control-v1-EntranceDevice-RelationType)
 Тип связки

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-EntranceDevice-RelationType-RELATION_TYPE_UNKNOWN"></a> [RELATION_TYPE_UNKNOWN](#keyapis-access_control-v1-EntranceDevice-RelationType-RELATION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-EntranceDevice-RelationType-FULL"></a> [FULL](#keyapis-access_control-v1-EntranceDevice-RelationType-FULL) | Полная связь |
| 2 | <a id="keyapis-access_control-v1-EntranceDevice-RelationType-PARTIAL"></a> [PARTIAL](#keyapis-access_control-v1-EntranceDevice-RelationType-PARTIAL) | Частичная связь |




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

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

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




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

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-EntranceDevicePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_control-v1-EntranceDevicePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-EntranceDevicePaging-OrderByType-ORPON_THEN_ENTRANCE_NUMBER"></a> [ORPON_THEN_ENTRANCE_NUMBER](#keyapis-access_control-v1-EntranceDevicePaging-OrderByType-ORPON_THEN_ENTRANCE_NUMBER) | По ОРПОНу и номеру подъезда |
| 2 | <a id="keyapis-access_control-v1-EntranceDevicePaging-OrderByType-DEVICE_ID"></a> [DEVICE_ID](#keyapis-access_control-v1-EntranceDevicePaging-OrderByType-DEVICE_ID) | По идентификатору устройства |




<a name="keyapis-access_control-v1-EntranceFilter-CompanyRelationType"></a>

### [EntranceFilter.CompanyRelationType](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType)
 Справочник типов связи компании с подъездами

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-EntranceFilter-CompanyRelationType-COMPANY_RELATION_TYPE_UNKNOWN"></a> [COMPANY_RELATION_TYPE_UNKNOWN](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType-COMPANY_RELATION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-EntranceFilter-CompanyRelationType-DEFAULT"></a> [DEFAULT](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType-DEFAULT) | Значение по умолчанию |
| 2 | <a id="keyapis-access_control-v1-EntranceFilter-CompanyRelationType-MANAGEMENT"></a> [MANAGEMENT](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType-MANAGEMENT) | Управляющая компания владеет квартирограммой |
| 3 | <a id="keyapis-access_control-v1-EntranceFilter-CompanyRelationType-DEVICE_SERVICE"></a> [DEVICE_SERVICE](#keyapis-access_control-v1-EntranceFilter-CompanyRelationType-DEVICE_SERVICE) | Домофонная компания обслуживает квартирограмму |




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

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

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




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

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-EntrancePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_control-v1-EntrancePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-EntrancePaging-OrderByType-ORPON_THEN_ENTRANCE_NUMBER"></a> [ORPON_THEN_ENTRANCE_NUMBER](#keyapis-access_control-v1-EntrancePaging-OrderByType-ORPON_THEN_ENTRANCE_NUMBER) | По ОРПОНу и номеру подъезда |


 <!-- 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 |

