# Протокол

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

- [keyapis/access_control/v1/keyapis_access_control_sync_v1.proto](#keyapis_access_control_v1_keyapis_access_control_sync_v1-proto)
    - [SyncService](#keyapis-access_control-v1-SyncService)
  
    - [BuildingSync](#keyapis-access_control-v1-BuildingSync)
    - [GetSyncBuildingsRequest](#keyapis-access_control-v1-GetSyncBuildingsRequest)
    - [GetSyncBuildingsResponse](#keyapis-access_control-v1-GetSyncBuildingsResponse)
    - [GetSyncBuildingsResponse.BuildingList](#keyapis-access_control-v1-GetSyncBuildingsResponse-BuildingList)
    - [GetSyncBuildingsResponse.Error](#keyapis-access_control-v1-GetSyncBuildingsResponse-Error)
    - [PostSyncBuildingRequest](#keyapis-access_control-v1-PostSyncBuildingRequest)
    - [PostSyncBuildingResponse](#keyapis-access_control-v1-PostSyncBuildingResponse)
    - [PostSyncBuildingResponse.Error](#keyapis-access_control-v1-PostSyncBuildingResponse-Error)
  


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




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

## [keyapis/access_control/v1/keyapis_access_control_sync_v1.proto](/protos/key/keyapis/access_control/v1/keyapis_access_control_sync_v1.proto)
Сервис сихронизации объектов


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

### SyncService
 Сервис для сихронизации объектов

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-access_control-v1-PostSyncBuilding"></a> [PostSyncBuilding](#keyapis-access_control-v1-PostSyncBuilding) | Метод частичного обновления дома, только данными из DaData. Метод доступен для: admin, service | [keyapis.access_control.v1.PostSyncBuildingRequest](#keyapis-access_control-v1-PostSyncBuildingRequest) | [keyapis.access_control.v1.PostSyncBuildingResponse](#keyapis-access_control-v1-PostSyncBuildingResponse) |
| <a id="keyapis-access_control-v1-GetSyncBuildings"></a> [GetSyncBuildings](#keyapis-access_control-v1-GetSyncBuildings) | Метод получения списка домов для обновления. Метод доступен для: admin, service | [keyapis.access_control.v1.GetSyncBuildingsRequest](#keyapis-access_control-v1-GetSyncBuildingsRequest) | [keyapis.access_control.v1.GetSyncBuildingsResponse](#keyapis-access_control-v1-GetSyncBuildingsResponse) |

 <!-- end services -->


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


### [BuildingSync](#keyapis-access_control-v1-BuildingSync)
 Дом для синхронизации


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-BuildingSync-id"></a> [id](#keyapis-access_control-v1-BuildingSync-id) | Идентификатор дома |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-BuildingSync-orpon"></a> [orpon](#keyapis-access_control-v1-BuildingSync-orpon) | ОРПОН |    [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-city"></a> [city](#keyapis-access_control-v1-BuildingSync-city) | Город |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-street"></a> [street](#keyapis-access_control-v1-BuildingSync-street) | Улица |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-number"></a> [number](#keyapis-access_control-v1-BuildingSync-number) | Номер дома |    [string](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-city_orpon"></a> [city_orpon](#keyapis-access_control-v1-BuildingSync-city_orpon) | ОРПОН города, в котором находится дом |    [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-region_orpon"></a> [region_orpon](#keyapis-access_control-v1-BuildingSync-region_orpon) | ОРПОН региона |    [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-area"></a> [area](#keyapis-access_control-v1-BuildingSync-area) | Наименование муниципального района. # Диапазон: 0..64 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-area_orpon"></a> [area_orpon](#keyapis-access_control-v1-BuildingSync-area_orpon) | ОРПОН муниципального района. # Диапазон: 0..9999999999 |    [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-area_kladr"></a> [area_kladr](#keyapis-access_control-v1-BuildingSync-area_kladr) | КЛАДР муниципального района. # Диапазон: 0..32 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-capital_marker"></a> [capital_marker](#keyapis-access_control-v1-BuildingSync-capital_marker) | Признак принадлежности населённого пункта к столичному статусу. 1 — центр района. 2 — центр региона. 3 — центр района и региона. 4 — центральный район региона. 0 — ничего из перечисленного. # Диапазон: 0..4 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-city_kladr"></a> [city_kladr](#keyapis-access_control-v1-BuildingSync-city_kladr) | КЛАДР-код города. # Диапазон: 0..17 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-kladr"></a> [kladr](#keyapis-access_control-v1-BuildingSync-kladr) | КЛАДР-код строения. # Диапазон: 0..17 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-fias_level"></a> [fias_level](#keyapis-access_control-v1-BuildingSync-fias_level) | Уровень детализации, до которого адрес найден в ФИАС. 0 — страна. 1 — регион. 3 — район. 4 — город. 5 — район города. 6 — населенный пункт. 7 — улица. 8 — дом. 9 — квартира. 65 — планировочная структура. 90 — доп. территория. 91 — улица в доп. территории. -1 — иностранный или пустой. # Диапазон: -1..99 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-fias_actuality_state"></a> [fias_actuality_state](#keyapis-access_control-v1-BuildingSync-fias_actuality_state) | Уровень детализации, до которого адрес найден в ФИАС. 0 — актуальный. 1-50 — переименован. 51 — переподчинен. 99 — удален. # Диапазон: 0..99 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-geo_lat"></a> [geo_lat](#keyapis-access_control-v1-BuildingSync-geo_lat) | Координаты: широта |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-geo_lon"></a> [geo_lon](#keyapis-access_control-v1-BuildingSync-geo_lon) | Координаты: долгота |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-okato"></a> [okato](#keyapis-access_control-v1-BuildingSync-okato) | Код ОКАТО |    [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-oktmo"></a> [oktmo](#keyapis-access_control-v1-BuildingSync-oktmo) | Код ОКТМО |    [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-postal_code"></a> [postal_code](#keyapis-access_control-v1-BuildingSync-postal_code) | Почтовый индекс |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-region"></a> [region](#keyapis-access_control-v1-BuildingSync-region) | Наименование региона. # Диапазон: 0..64 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-region_kladr"></a> [region_kladr](#keyapis-access_control-v1-BuildingSync-region_kladr) | КЛАДР-код региона. # Диапазон: 0..32 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-street_kladr"></a> [street_kladr](#keyapis-access_control-v1-BuildingSync-street_kladr) | КЛАДР-код улицы. # Диапазон: 0..32 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-street_orpon"></a> [street_orpon](#keyapis-access_control-v1-BuildingSync-street_orpon) | ОРПОН улицы. # Диапазон: 0..9999999999 |    [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-access_control-v1-BuildingSync-house_kladr"></a> [house_kladr](#keyapis-access_control-v1-BuildingSync-house_kladr) | КЛАДР-код дома. # Диапазон: 0..32 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-GetSyncBuildingsRequest-batch_size"></a> [batch_size](#keyapis-access_control-v1-GetSyncBuildingsRequest-batch_size) | Количество. По умолчанию 10. # Диапазон: 10..5000 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-GetSyncBuildingsRequest-last_sync_before_at"></a> [last_sync_before_at](#keyapis-access_control-v1-GetSyncBuildingsRequest-last_sync_before_at) | Дата, старше которой должны вернуться записи для синхронизации |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | REQUIRED|






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


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


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






<a name="keyapis-access_control-v1-GetSyncBuildingsResponse-BuildingList"></a>


### [GetSyncBuildingsResponse.BuildingList](#keyapis-access_control-v1-GetSyncBuildingsResponse-BuildingList)
 Список домов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-GetSyncBuildingsResponse-BuildingList-buildings"></a> [buildings](#keyapis-access_control-v1-GetSyncBuildingsResponse-BuildingList-buildings) | Список домов |  repeated  [keyapis.access_control.v1.BuildingSync](#keyapis-access_control-v1-BuildingSync) | <nil>|






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


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


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






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


### [PostSyncBuildingRequest](#keyapis-access_control-v1-PostSyncBuildingRequest)
 Запрос частичного обновления дома


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-PostSyncBuildingRequest-building_id"></a> [building_id](#keyapis-access_control-v1-PostSyncBuildingRequest-building_id) | Передается в случае когда изменения данных не требуются, но необходимо зафиксировать дату синхронизации |  optional  [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-PostSyncBuildingRequest-data"></a> [data](#keyapis-access_control-v1-PostSyncBuildingRequest-data) | Дом с обновленными данными из DaData |  optional  [keyapis.access_control.v1.BuildingSync](#keyapis-access_control-v1-BuildingSync) | REQUIRED|






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


### [PostSyncBuildingResponse](#keyapis-access_control-v1-PostSyncBuildingResponse)
 Ответ на запрос частичного обновления дома


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






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


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


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