# Протокол

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

- [keyapis/telemetry_control/v1/keyapis_telemetry_control_building_gis_v1.proto](#keyapis_telemetry_control_v1_keyapis_telemetry_control_building_gis_v1-proto)
    - [BuildingGisService](#keyapis-telemetry_control-v1-BuildingGisService)
  
    - [BuildingGisAttributes](#keyapis-telemetry_control-v1-BuildingGisAttributes)
    - [BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes)
    - [GetBuildingGisAttributesRequest](#keyapis-telemetry_control-v1-GetBuildingGisAttributesRequest)
    - [GetBuildingGisAttributesResponse](#keyapis-telemetry_control-v1-GetBuildingGisAttributesResponse)
    - [PutBuildingGisAttributesRequest](#keyapis-telemetry_control-v1-PutBuildingGisAttributesRequest)
    - [PutBuildingGisAttributesResponse](#keyapis-telemetry_control-v1-PutBuildingGisAttributesResponse)
  


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




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

## [keyapis/telemetry_control/v1/keyapis_telemetry_control_building_gis_v1.proto](/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_building_gis_v1.proto)
Сервис реализует функционал управления атрибутами выгрузки показаний в ГИС ЖКХ по объектам строительства телеметрии


<a name="keyapis-telemetry_control-v1-BuildingGisService"></a>

### BuildingGisService
 Сервис управления атрибутами выгрузки показаний в ГИС ЖКХ по объектам строительства.
Авторизация:
  - Authorization: Bearer token

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-telemetry_control-v1-GetBuildingGisAttributes"></a> [GetBuildingGisAttributes](#keyapis-telemetry_control-v1-GetBuildingGisAttributes) | Метод получения атрибутов выгрузки показаний в ГИС ЖКХ объекта строительства. Метод доступен для: Token: admin | [keyapis.telemetry_control.v1.GetBuildingGisAttributesRequest](#keyapis-telemetry_control-v1-GetBuildingGisAttributesRequest) | [keyapis.telemetry_control.v1.GetBuildingGisAttributesResponse](#keyapis-telemetry_control-v1-GetBuildingGisAttributesResponse) |
| <a id="keyapis-telemetry_control-v1-PutBuildingGisAttributes"></a> [PutBuildingGisAttributes](#keyapis-telemetry_control-v1-PutBuildingGisAttributes) | Метод сохранения атрибутов выгрузки показаний в ГИС ЖКХ объекта строительства. Метод доступен для: Token: admin | [keyapis.telemetry_control.v1.PutBuildingGisAttributesRequest](#keyapis-telemetry_control-v1-PutBuildingGisAttributesRequest) | [keyapis.telemetry_control.v1.PutBuildingGisAttributesResponse](#keyapis-telemetry_control-v1-PutBuildingGisAttributesResponse) |

 <!-- end services -->


<a name="keyapis-telemetry_control-v1-BuildingGisAttributes"></a>


### [BuildingGisAttributes](#keyapis-telemetry_control-v1-BuildingGisAttributes)
 Атрибуты выгрузки показаний в ГИС ЖКХ объекта строительства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-id"></a> [id](#keyapis-telemetry_control-v1-BuildingGisAttributes-id) | Идентификатор объекта строительства |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-hot_water"></a> [hot_water](#keyapis-telemetry_control-v1-BuildingGisAttributes-hot_water) | Горячая вода |    [keyapis.telemetry_control.v1.BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes) | <nil>|
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-cold_water"></a> [cold_water](#keyapis-telemetry_control-v1-BuildingGisAttributes-cold_water) | Холодная вода |    [keyapis.telemetry_control.v1.BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes) | <nil>|
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-heat"></a> [heat](#keyapis-telemetry_control-v1-BuildingGisAttributes-heat) | Теплоэнергия |    [keyapis.telemetry_control.v1.BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes) | <nil>|
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-gas"></a> [gas](#keyapis-telemetry_control-v1-BuildingGisAttributes-gas) | Газ |    [keyapis.telemetry_control.v1.BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes) | <nil>|
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-electricity"></a> [electricity](#keyapis-telemetry_control-v1-BuildingGisAttributes-electricity) | Электроэнергия |    [keyapis.telemetry_control.v1.BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes) | <nil>|






<a name="keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes"></a>


### [BuildingGisAttributes.Attributes](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes)
 Атрибуты выгрузки показаний для типа ресурса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes-is_enabled"></a> [is_enabled](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes-is_enabled) | Флаг включения передачи показаний |    [bool](#scalar-types) | REQUIRED|
| <a id="keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes-start_day"></a> [start_day](#keyapis-telemetry_control-v1-BuildingGisAttributes-Attributes-start_day) | Число месяца начала передачи показаний. # Диапазон: 15..25 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-telemetry_control-v1-GetBuildingGisAttributesRequest"></a>


### [GetBuildingGisAttributesRequest](#keyapis-telemetry_control-v1-GetBuildingGisAttributesRequest)
 Запрос получения атрибутов выгрузки показаний в ГИС ЖКХ объекта строительства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-GetBuildingGisAttributesRequest-id"></a> [id](#keyapis-telemetry_control-v1-GetBuildingGisAttributesRequest-id) | Идентификатор объекта строительства |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-telemetry_control-v1-GetBuildingGisAttributesResponse"></a>


### [GetBuildingGisAttributesResponse](#keyapis-telemetry_control-v1-GetBuildingGisAttributesResponse)
 Ответ на запрос получения атрибутов выгрузки показаний в ГИС ЖКХ объекта строительства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-GetBuildingGisAttributesResponse-data"></a> [data](#keyapis-telemetry_control-v1-GetBuildingGisAttributesResponse-data) | Атрибутов выгрузки показаний в ГИС ЖКХ |  optional  [keyapis.telemetry_control.v1.BuildingGisAttributes](#keyapis-telemetry_control-v1-BuildingGisAttributes) | <nil>|






<a name="keyapis-telemetry_control-v1-PutBuildingGisAttributesRequest"></a>


### [PutBuildingGisAttributesRequest](#keyapis-telemetry_control-v1-PutBuildingGisAttributesRequest)
 Запрос сохранения атрибутов выгрузки показаний в ГИС ЖКХ объекта строительства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-PutBuildingGisAttributesRequest-data"></a> [data](#keyapis-telemetry_control-v1-PutBuildingGisAttributesRequest-data) | Атрибуты выгрузки показаний в ГИС ЖКХ объекта строительства |    [keyapis.telemetry_control.v1.BuildingGisAttributes](#keyapis-telemetry_control-v1-BuildingGisAttributes) | REQUIRED|






<a name="keyapis-telemetry_control-v1-PutBuildingGisAttributesResponse"></a>


### [PutBuildingGisAttributesResponse](#keyapis-telemetry_control-v1-PutBuildingGisAttributesResponse)
 Ответ на запрос сохранения атрибутов выгрузки показаний в ГИС ЖКХ объекта строительства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-telemetry_control-v1-PutBuildingGisAttributesResponse-data"></a> [data](#keyapis-telemetry_control-v1-PutBuildingGisAttributesResponse-data) | Объект строительства |  optional  [keyapis.telemetry_control.v1.BuildingGisAttributes](#keyapis-telemetry_control-v1-BuildingGisAttributes) | <nil>|





 <!-- end messages -->

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