# Протокол

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

- [keyapis/ecosystem/v1/keyapis_ecosystem_lego_adapter_v1.proto](#keyapis_ecosystem_v1_keyapis_ecosystem_lego_adapter_v1-proto)
    - [LegoAdapterService](#keyapis-ecosystem-v1-LegoAdapterService)
  
    - [GetLegoAdapterServiceCheckRequest](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest)
    - [GetLegoAdapterServiceCheckResponse](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse)
    - [GetLegoAdapterServiceCheckResponse.Error](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error)
    - [GetLegoAdapterServiceCheckResponse.Error.EcosystemApiError](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-EcosystemApiError)
    - [Service](#keyapis-ecosystem-v1-Service)
    - [ValidationError](#keyapis-ecosystem-v1-ValidationError)
  
    - [Service.Type](#keyapis-ecosystem-v1-Service-Type)
  


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




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

## [keyapis/ecosystem/v1/keyapis_ecosystem_lego_adapter_v1.proto](/protos/key/keyapis/ecosystem/v1/keyapis_ecosystem_lego_adapter_v1.proto)
Cервис-адаптер вокруг Lego API экосистемы РТК


<a name="keyapis-ecosystem-v1-LegoAdapterService"></a>

### LegoAdapterService
 Cервис-адаптер вокруг Lego API экосистемы РТК

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheck"></a> [GetLegoAdapterServiceCheck](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheck) | Метод проверки услуги. Возвращает true если хотя бы у одного аккаунта на квартире есть нужный сервис и он содержит активный компонент. Метод доступен для: admin, service | [keyapis.ecosystem.v1.GetLegoAdapterServiceCheckRequest](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest) | [keyapis.ecosystem.v1.GetLegoAdapterServiceCheckResponse](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse) |

 <!-- end services -->


<a name="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest"></a>


### [GetLegoAdapterServiceCheckRequest](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest)
 Запрос проверки услуги на квартире


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest-orpon"></a> [orpon](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest-orpon) | ОРПОН. Идентификатор дома. # Диапазон: 0..9223372036854775807 |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest-room_number"></a> [room_number](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest-room_number) | Номер квартиры. # Паттерн: /^[0-9]{1,4}$/ |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest-service_type"></a> [service_type](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckRequest-service_type) | Тип услуги |    [keyapis.ecosystem.v1.Service.Type](#keyapis-ecosystem-v1-Service-Type) | REQUIRED|






<a name="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse"></a>


### [GetLegoAdapterServiceCheckResponse](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse)
 Результат запроса метода проверки услуги на квартире


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-data"></a> [data](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-data) | Наличие активной услуги на квартире |  optional  [bool](#scalar-types) | <nil>|
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-error"></a> [error](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-error) | Ошибка |  optional  [keyapis.ecosystem.v1.GetLegoAdapterServiceCheckResponse.Error](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error) | <nil>|






<a name="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error"></a>


### [GetLegoAdapterServiceCheckResponse.Error](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error)
 Ошибка запроса метода проверки услуги на квартире


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-validation"></a> [validation](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-validation) | Ошибка валидации запроса информации об услугах пользователя |  optional  [keyapis.ecosystem.v1.ValidationError](#keyapis-ecosystem-v1-ValidationError) | <nil>|
| <a id="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-ecosystem_api_error"></a> [ecosystem_api_error](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-ecosystem_api_error) | Ошибка запроса к API экосистемы |  optional  [keyapis.ecosystem.v1.GetLegoAdapterServiceCheckResponse.Error.EcosystemApiError](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-EcosystemApiError) | <nil>|






<a name="keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-EcosystemApiError"></a>


### [GetLegoAdapterServiceCheckResponse.Error.EcosystemApiError](#keyapis-ecosystem-v1-GetLegoAdapterServiceCheckResponse-Error-EcosystemApiError)
 Ошибка запроса к API экосистемы






<a name="keyapis-ecosystem-v1-Service"></a>


### [Service](#keyapis-ecosystem-v1-Service)
 Услуга






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


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


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





 <!-- end messages -->



<a name="keyapis-ecosystem-v1-Service-Type"></a>

### [Service.Type](#keyapis-ecosystem-v1-Service-Type)
 Тип услуги

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-ecosystem-v1-Service-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-ecosystem-v1-Service-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-ecosystem-v1-Service-Type-SOTOVAYA_SVYAZ_MVNO"></a> [SOTOVAYA_SVYAZ_MVNO](#keyapis-ecosystem-v1-Service-Type-SOTOVAYA_SVYAZ_MVNO) | Cотовая связь |
| 2 | <a id="keyapis-ecosystem-v1-Service-Type-IPTV"></a> [IPTV](#keyapis-ecosystem-v1-Service-Type-IPTV) | Цифровое интерактивное ТВ |
| 3 | <a id="keyapis-ecosystem-v1-Service-Type-SHPD"></a> [SHPD](#keyapis-ecosystem-v1-Service-Type-SHPD) | Домашний интернет |
| 4 | <a id="keyapis-ecosystem-v1-Service-Type-KABELNOE_TV"></a> [KABELNOE_TV](#keyapis-ecosystem-v1-Service-Type-KABELNOE_TV) | Кабельное цифровое ТВ |
| 5 | <a id="keyapis-ecosystem-v1-Service-Type-FIKSIROVANNAYA_SVYAZ"></a> [FIKSIROVANNAYA_SVYAZ](#keyapis-ecosystem-v1-Service-Type-FIKSIROVANNAYA_SVYAZ) | Стационарный телефон |
| 6 | <a id="keyapis-ecosystem-v1-Service-Type-ROSTELECOM_LYCEUM"></a> [ROSTELECOM_LYCEUM](#keyapis-ecosystem-v1-Service-Type-ROSTELECOM_LYCEUM) | Лицей |
| 7 | <a id="keyapis-ecosystem-v1-Service-Type-SMART_HOUSE"></a> [SMART_HOUSE](#keyapis-ecosystem-v1-Service-Type-SMART_HOUSE) | Умный дом |
| 8 | <a id="keyapis-ecosystem-v1-Service-Type-JURIST"></a> [JURIST](#keyapis-ecosystem-v1-Service-Type-JURIST) | Юрист |
| 9 | <a id="keyapis-ecosystem-v1-Service-Type-WINK"></a> [WINK](#keyapis-ecosystem-v1-Service-Type-WINK) | WINK ТВ |
| 10 | <a id="keyapis-ecosystem-v1-Service-Type-SALE_EQUIPMENT"></a> [SALE_EQUIPMENT](#keyapis-ecosystem-v1-Service-Type-SALE_EQUIPMENT) | Оборудование |
| 11 | <a id="keyapis-ecosystem-v1-Service-Type-SMART_INTERCOM"></a> [SMART_INTERCOM](#keyapis-ecosystem-v1-Service-Type-SMART_INTERCOM) | Ключ |
| 12 | <a id="keyapis-ecosystem-v1-Service-Type-SMART_BARRIER"></a> [SMART_BARRIER](#keyapis-ecosystem-v1-Service-Type-SMART_BARRIER) | Шлагбаум |
| 13 | <a id="keyapis-ecosystem-v1-Service-Type-WARRANTY_PLUS"></a> [WARRANTY_PLUS](#keyapis-ecosystem-v1-Service-Type-WARRANTY_PLUS) | Гарантия плюс |
| 14 | <a id="keyapis-ecosystem-v1-Service-Type-ANALOG_CABLE_TV"></a> [ANALOG_CABLE_TV](#keyapis-ecosystem-v1-Service-Type-ANALOG_CABLE_TV) | Аналоговое цифровое ТВ |
| 15 | <a id="keyapis-ecosystem-v1-Service-Type-OTT_PERSON"></a> [OTT_PERSON](#keyapis-ecosystem-v1-Service-Type-OTT_PERSON) | АЛЛЁ |
| 16 | <a id="keyapis-ecosystem-v1-Service-Type-WIFI"></a> [WIFI](#keyapis-ecosystem-v1-Service-Type-WIFI) | Беспроводной интернет |


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