Протокол¶
Оглавление¶
-
keyapis/access_control/v1/keyapis_access_control_building_v1.proto
- BuildingFilter
- BuildingPaging
- BuildingSubscriptionMode
- GetBuildingCountRequest
- GetBuildingCountResponse
- GetBuildingListRequest
- GetBuildingListResponse
- GetBuildingListResponse.Error
- GetBuildingOrponExistsRequest
- GetBuildingOrponExistsResponse
- GetBuildingOrponExistsResponse.Error
- GetBuildingOrponSubscriptionModeRequest
- GetBuildingOrponSubscriptionModeResponse
- GetBuildingOrponSubscriptionModeResponse.Error
- GetBuildingRequest
- GetBuildingResponse
- BuildingPaging.OrderByType
- BuildingSubscriptionMode.SubscriptionModeType
Схема классов¶
keyapis/access_control/v1/keyapis_access_control_building_v1.proto¶
Сервис домов
BuildingService¶
Сервис домов
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetBuilding | Метод получения Дома. Для пользователей типов owner, employee: в результат попадают только дома, которые привязаны к компании пользователя или дома квартирограамм привязанных к компании пользователя. Метод доступен для: admin, service, owner, employee, seller, external_seller, ltp_first, bti | keyapis.access_control.v1.GetBuildingRequest | keyapis.access_control.v1.GetBuildingResponse |
| GetBuildingList | Метод получения списка домов. Для пользователей типов owner, employee: в результат попадают только дома, которые привязаны к компании пользователя или дома квартирограамм привязанных к компании пользователя. При запросе через ApiKey происходит дополнительная фильтрация домов на основе доступности домов для этого ApiKey (фильтрация происходит по доступным AccessPoint для этой группы). Метод доступен для: admin, service, owner, employee, ltp_first, bti. Метод доступен для: ApiKey | keyapis.access_control.v1.GetBuildingListRequest | keyapis.access_control.v1.GetBuildingListResponse stream |
| GetBuildingCount | Метод получения количества домов. Для пользователей типов owner, employee: в результат попадают только дома, которые привязаны к компании пользователя или дома квартирограамм привязанных к компании пользователя. Метод доступен для: admin, service, owner, employee, ltp_first, bti | keyapis.access_control.v1.GetBuildingCountRequest | keyapis.access_control.v1.GetBuildingCountResponse |
| GetBuildingOrponSubscriptionMode | Метод получения статуса режима работы с подписками у помещений дома. Возвращает агрегированный статус по всем помещениям дома. Метод доступен для: admin, service, ltp_first, bti | keyapis.access_control.v1.GetBuildingOrponSubscriptionModeRequest | keyapis.access_control.v1.GetBuildingOrponSubscriptionModeResponse |
| GetBuildingOrponExists | Метод проверки существования дома по ОРПОН. Возвращает true если найден дом с указанным ОРПОН. Метод доступен для: admin, service | keyapis.access_control.v1.GetBuildingOrponExistsRequest | keyapis.access_control.v1.GetBuildingOrponExistsResponse |
Building¶
Дом
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор дома | int32 | |
| rf_id | Идентификатор РФ | int32 | REQUIRED |
| mrf_id | Идентификатор МРФ | int32 | REQUIRED |
| orpon | ОРПОН | int64 | REQUIRED |
| city | Город | string | REQUIRED |
| street | Улица | string | REQUIRED |
| number | Номер дома | string | |
| part | Корпус | string | |
| company_id | Идентификатор компании | int32 | REQUIRED |
| prefix | Префикс | string | |
| created_at | Дата создания. # Тип: DateTime | google.protobuf.Timestamp | OUTPUT_ONLY |
| deleted_at | Дата удаления. # Тип: DateTime | google.protobuf.Timestamp | OUTPUT_ONLY |
| flatgramm_id | Идентификатор квартирограммы | int32 | REQUIRED |
| city_orpon | ОРПОН города, в котором находится дом | int64 | |
| fias | Идентификатор в федеральной информационной адресной системе. Тип: Guid | google.protobuf.StringValue | |
| district | Наименование района города. # Диапазон: 0..200 | google.protobuf.StringValue | |
| unom | Уникальный номер адреса. # Диапазон: 0..9999999999 | google.protobuf.Int64Value | |
| region_orpon | ОРПОН региона | int64 | |
| utc_offset | Смещение таймзоны в минутах. # Диапазон: -720..840 | int32 | |
| is_key_purchase_possible_in_sale_points | Флаг указывает на то могут ли жители этого дома приобрести ключи домофона в партнёрских салонах или на маркетплейсах | bool | |
| is_key_purchase_possible_in_management_company | Флаг указывает на то могут ли жители этого дома приобретать ключи через управляющую компанию | bool | |
| is_key_purchase_possible_in_intercom_company | Флаг указывает на то могут ли жители этого дома приобрести ключи напрямую у домофонной компании | bool | |
| is_rfid_mifare_supported | Флаг указывает на то поддерживает ли дом использование RFID-меток с типом MIFARE | bool | |
| area | Наименование муниципального района. # Диапазон: 0..64 | google.protobuf.StringValue | |
| area_orpon | ОРПОН муниципального района. # Диапазон: 0..9999999999 | google.protobuf.Int64Value | |
| area_kladr | КЛАДР муниципального района. # Диапазон: 0..32 | google.protobuf.StringValue | |
| capital_marker | Признак принадлежности населённого пункта к столичному статусу. 1 — центр района. 2 — центр региона. 3 — центр района и региона. 4 — центральный район региона. 0 — ничего из перечисленного. # Диапазон: 0..4 | google.protobuf.Int32Value | |
| city_kladr | КЛАДР-код города. # Диапазон: 0..17 | google.protobuf.StringValue | |
| kladr | КЛАДР-код строения. # Диапазон: 0..17 | google.protobuf.StringValue | |
| fias_level | Уровень детализации, до которого адрес найден в ФИАС. 0 — страна. 1 — регион. 3 — район. 4 — город. 5 — район города. 6 — населенный пункт. 7 — улица. 8 — дом. 9 — квартира. 65 — планировочная структура. 90 — доп. территория. 91 — улица в доп. территории. -1 — иностранный или пустой. # Диапазон: -1..99 | google.protobuf.Int32Value | |
| fias_actuality_state | Уровень детализации, до которого адрес найден в ФИАС. 0 — актуальный. 1-50 — переименован. 51 — переподчинен. 99 — удален. # Диапазон: 0..99 | google.protobuf.Int32Value | |
| geo_lat | Координаты: широта | google.protobuf.DoubleValue | |
| geo_lon | Координаты: долгота | google.protobuf.DoubleValue | |
| okato | Код ОКАТО | google.protobuf.Int32Value | |
| oktmo | Код ОКТМО | google.protobuf.Int32Value | |
| postal_code | Почтовый индекс | google.protobuf.Int32Value | |
| region | Наименование региона. # Диапазон: 0..64 | google.protobuf.StringValue | |
| region_kladr | КЛАДР-код региона. # Диапазон: 0..32 | google.protobuf.StringValue | |
| street_kladr | КЛАДР-код улицы. # Диапазон: 0..32 | google.protobuf.StringValue | |
| street_orpon | ОРПОН улицы. # Диапазон: 0..9999999999 | google.protobuf.Int64Value |
BuildingFilter¶
Фильтр по домам
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| mrf_ids | По идентификаторам МРФ | repeated int32 | |
| rf_ids | По идентификаторам РФ | repeated int32 | |
| device_ids | По идентификаторам устройств | repeated int32 | |
| flatgramm_ids | По идентификаторам квартирограмм | repeated int32 | |
| orpons | По орпонам | repeated int64 |
BuildingPaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CREATED_AT | keyapis.access_control.v1.BuildingPaging.OrderByType | |
| direction_type | Тип направления сортировки. # По умолчанию: DESC | keyapis.access_control.v1.BuildingPaging.DirectionType | |
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
BuildingSubscriptionMode¶
Агрегированный статус режима работы с подписками на доме
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| subscription_mode_type | Режим работы с подписками на доме | keyapis.access_control.v1.BuildingSubscriptionMode.SubscriptionModeType |
GetBuildingCountRequest¶
Запрос получения количества домов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.access_control.v1.BuildingFilter | REQUIRED |
GetBuildingCountResponse¶
Ответ на запрос получения количества домов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Количество | optional int32 |
GetBuildingListRequest¶
Запрос получения списка домов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.access_control.v1.BuildingFilter | |
| paging | Стандартный постраничный вывод | optional keyapis.access_control.v1.BuildingPaging |
GetBuildingListResponse¶
Ответ на запрос получения списка домов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Квартира | optional keyapis.access_control.v1.Building | |
| error | Ошибка | optional keyapis.access_control.v1.GetBuildingListResponse.Error |
GetBuildingListResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetBuildingOrponExistsRequest¶
Запрос проверки существования дома по ОРПОН
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| orpon | ОРПОН дома. # Диапазон: 1..9223372036854775807 | int64 | REQUIRED |
GetBuildingOrponExistsResponse¶
Ответ на запрос проверки существования дома по ОРПОН
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Результат проверки: true - если дом существует, false - в противном случае | optional bool | |
| error | Ошибка | optional keyapis.access_control.v1.GetBuildingOrponExistsResponse.Error |
GetBuildingOrponExistsResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetBuildingOrponSubscriptionModeRequest¶
Запрос получения агрегированного статуса режима работы с подписками дома
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| orpon | ОРПОН. # Диапазон: 1..9223372036854775807 | int64 | REQUIRED |
GetBuildingOrponSubscriptionModeResponse¶
Ответ на запрос получения агрегированного статуса режима работы с подписками дома
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Агрегированный статус режима работы с подписками дома | optional keyapis.access_control.v1.BuildingSubscriptionMode | |
| error | Ошибка | optional keyapis.access_control.v1.GetBuildingOrponSubscriptionModeResponse.Error |
GetBuildingOrponSubscriptionModeResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
GetBuildingRequest¶
Запрос получения дома
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор дома | int32 | REQUIRED |
GetBuildingResponse¶
Ответ на запрос получения дома
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Квартира | optional keyapis.access_control.v1.Building | |
| error | Ошибка | optional keyapis.access_control.v1.GetBuildingResponse.Error |
GetBuildingResponse.Error¶
Ошибка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.access_control.v1.ValidationError |
BuildingPaging.DirectionType¶
Справочник типов направлений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
BuildingPaging.OrderByType¶
Справочник типов значений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ID | По идентификатору |
| 2 | CREATED_AT | По времени создания |
| 3 | STREET_THEN_NUMBER_THEN_PART | По улице, номеру дома, корпусу |
BuildingSubscriptionMode.SubscriptionModeType¶
Справочник режимов работы с подписками
| Номер | Тип | Название |
|---|---|---|
| 0 | SUBSCRIPTION_MODE_TYPE_UNKNOWN | Значение не указано |
| 1 | ENABLED | Режим работы с подписками включен на всех помещениях дома |
| 2 | PARTIALLY_ENABLED | Режим работы с подписками включен на некоторых помещениях дома |
| 3 | DISABLED | Режим работы с подписками выключен на всех помещениях дома |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | 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 | 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 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | 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 | 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 | 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 | 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 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |