# Протокол

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

- [keyapis/access_control/v1/keyapis_access_control_room_user_v1.proto](#keyapis_access_control_v1_keyapis_access_control_room_user_v1-proto)
    - [RoomUserService](#keyapis-access_control-v1-RoomUserService)
  
    - [GetRoomUserCountRequest](#keyapis-access_control-v1-GetRoomUserCountRequest)
    - [GetRoomUserCountResponse](#keyapis-access_control-v1-GetRoomUserCountResponse)
    - [GetRoomUserListRequest](#keyapis-access_control-v1-GetRoomUserListRequest)
    - [GetRoomUserListResponse](#keyapis-access_control-v1-GetRoomUserListResponse)
    - [GetRoomUserListResponse.Error](#keyapis-access_control-v1-GetRoomUserListResponse-Error)
    - [RoomUser](#keyapis-access_control-v1-RoomUser)
    - [RoomUserFilter](#keyapis-access_control-v1-RoomUserFilter)
    - [RoomUserPaging](#keyapis-access_control-v1-RoomUserPaging)
  
    - [RoomUserPaging.DirectionType](#keyapis-access_control-v1-RoomUserPaging-DirectionType)
    - [RoomUserPaging.OrderByType](#keyapis-access_control-v1-RoomUserPaging-OrderByType)
  


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




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

## [keyapis/access_control/v1/keyapis_access_control_room_user_v1.proto](/protos/key/keyapis/access_control/v1/keyapis_access_control_room_user_v1.proto)
Сервис связей помещений и пользователей


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

### RoomUserService
 Сервис управления доступом пользователей

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-access_control-v1-GetRoomUserList"></a> [GetRoomUserList](#keyapis-access_control-v1-GetRoomUserList) | Метод получения списка связей помещений и пользователей. Метод доступен для: admin, service, bti, ltp_first | [keyapis.access_control.v1.GetRoomUserListRequest](#keyapis-access_control-v1-GetRoomUserListRequest) | [keyapis.access_control.v1.GetRoomUserListResponse](#keyapis-access_control-v1-GetRoomUserListResponse) stream |
| <a id="keyapis-access_control-v1-GetRoomUserCount"></a> [GetRoomUserCount](#keyapis-access_control-v1-GetRoomUserCount) | Метод получения количества связей помещений и пользователей. Метод доступен для: admin, service, bti, ltp_first | [keyapis.access_control.v1.GetRoomUserCountRequest](#keyapis-access_control-v1-GetRoomUserCountRequest) | [keyapis.access_control.v1.GetRoomUserCountResponse](#keyapis-access_control-v1-GetRoomUserCountResponse) |

 <!-- end services -->


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


### [GetRoomUserCountRequest](#keyapis-access_control-v1-GetRoomUserCountRequest)
 Запрос получения количества связей помещений и пользователей


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






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


### [GetRoomUserCountResponse](#keyapis-access_control-v1-GetRoomUserCountResponse)
 Ответ на запрос получения количества связей помещений и пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-GetRoomUserCountResponse-data"></a> [data](#keyapis-access_control-v1-GetRoomUserCountResponse-data) | Количество |  optional  [int32](#scalar-types) | <nil>|






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


### [GetRoomUserListRequest](#keyapis-access_control-v1-GetRoomUserListRequest)
 Запрос получения списка связей помещений и пользователей


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






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


### [GetRoomUserListResponse](#keyapis-access_control-v1-GetRoomUserListResponse)
 Ответ на запрос получения списка связей помещений и пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-GetRoomUserListResponse-data"></a> [data](#keyapis-access_control-v1-GetRoomUserListResponse-data) | Связь помещения и пользователя |  optional  [keyapis.access_control.v1.RoomUser](#keyapis-access_control-v1-RoomUser) | <nil>|
| <a id="keyapis-access_control-v1-GetRoomUserListResponse-error"></a> [error](#keyapis-access_control-v1-GetRoomUserListResponse-error) | Ошибка |  optional  [keyapis.access_control.v1.GetRoomUserListResponse.Error](#keyapis-access_control-v1-GetRoomUserListResponse-Error) | <nil>|






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


### [GetRoomUserListResponse.Error](#keyapis-access_control-v1-GetRoomUserListResponse-Error)
 Ошибка


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






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


### [RoomUser](#keyapis-access_control-v1-RoomUser)
 Связь помещения и пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-RoomUser-orpon"></a> [orpon](#keyapis-access_control-v1-RoomUser-orpon) | ОРПОН дома |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-RoomUser-room_number"></a> [room_number](#keyapis-access_control-v1-RoomUser-room_number) | Номер квартиры. # Диапазон: 1..4 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-RoomUser-user_id"></a> [user_id](#keyapis-access_control-v1-RoomUser-user_id) | Идентификатор пользователя. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|






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


### [RoomUserFilter](#keyapis-access_control-v1-RoomUserFilter)
 Фильтр по связям помещений и пользователей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-RoomUserFilter-orpons"></a> [orpons](#keyapis-access_control-v1-RoomUserFilter-orpons) | По ОРПОНам |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-RoomUserFilter-room_numbers"></a> [room_numbers](#keyapis-access_control-v1-RoomUserFilter-room_numbers) | По номерам квартир |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-RoomUserFilter-user_ids"></a> [user_ids](#keyapis-access_control-v1-RoomUserFilter-user_ids) | По идентификаторам пользователей |  repeated  [int32](#scalar-types) | <nil>|






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


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


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





 <!-- end messages -->



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

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

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




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

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-RoomUserPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-access_control-v1-RoomUserPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-RoomUserPaging-OrderByType-USER_ID"></a> [USER_ID](#keyapis-access_control-v1-RoomUserPaging-OrderByType-USER_ID) | По идентификатору |
| 2 | <a id="keyapis-access_control-v1-RoomUserPaging-OrderByType-ORPON_THEN_NUMBER"></a> [ORPON_THEN_NUMBER](#keyapis-access_control-v1-RoomUserPaging-OrderByType-ORPON_THEN_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 |