# Протокол

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

- [keyapis/vc/v1/keyapis_vc_camera_location_data_v1.proto](#keyapis_vc_v1_keyapis_vc_camera_location_data_v1-proto)
    - [CameraLocationDataService](#keyapis-vc-v1-CameraLocationDataService)
  
    - [CameraLocationData](#keyapis-vc-v1-CameraLocationData)
    - [CameraLocationData.Building](#keyapis-vc-v1-CameraLocationData-Building)
    - [CameraLocationData.Company](#keyapis-vc-v1-CameraLocationData-Company)
    - [GetCameraLocationDataRequest](#keyapis-vc-v1-GetCameraLocationDataRequest)
    - [GetCameraLocationDataResponse](#keyapis-vc-v1-GetCameraLocationDataResponse)
    - [GetCameraLocationDataResponse.Error](#keyapis-vc-v1-GetCameraLocationDataResponse-Error)
  
    - [CameraLocationData.DeviceType](#keyapis-vc-v1-CameraLocationData-DeviceType)
    - [CameraLocationData.StatusType](#keyapis-vc-v1-CameraLocationData-StatusType)
  


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




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

## [keyapis/vc/v1/keyapis_vc_camera_location_data_v1.proto](/protos/key/keyapis/vc/v1/keyapis_vc_camera_location_data_v1.proto)
Спецификация для получения данных o местонахождении камеры


<a name="keyapis-vc-v1-CameraLocationDataService"></a>

### CameraLocationDataService
 Сервис получения данных o местонахождении камеры

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-vc-v1-GetCameraLocationData"></a> [GetCameraLocationData](#keyapis-vc-v1-GetCameraLocationData) | Метод получения данных o местонахождении камеры. Метод доступен для: ApiKey | [keyapis.vc.v1.GetCameraLocationDataRequest](#keyapis-vc-v1-GetCameraLocationDataRequest) | [keyapis.vc.v1.GetCameraLocationDataResponse](#keyapis-vc-v1-GetCameraLocationDataResponse) |

 <!-- end services -->


<a name="keyapis-vc-v1-CameraLocationData"></a>


### [CameraLocationData](#keyapis-vc-v1-CameraLocationData)
 Данные o местонахождении камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraLocationData-uid"></a> [uid](#keyapis-vc-v1-CameraLocationData-uid) | Идентификатор видеопотока в системе Видеокомфорт. Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-device_type"></a> [device_type](#keyapis-vc-v1-CameraLocationData-device_type) | Тип устройства. # Тип: byte |    [keyapis.vc.v1.CameraLocationData.DeviceType](#keyapis-vc-v1-CameraLocationData-DeviceType) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-model"></a> [model](#keyapis-vc-v1-CameraLocationData-model) | Модель устройства |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-serial_number"></a> [serial_number](#keyapis-vc-v1-CameraLocationData-serial_number) | Серийный номер устройства |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-hw_version"></a> [hw_version](#keyapis-vc-v1-CameraLocationData-hw_version) | Версия аппаратного обеспечения |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-sw_version"></a> [sw_version](#keyapis-vc-v1-CameraLocationData-sw_version) | Версия программного обеспечения |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-mac"></a> [mac](#keyapis-vc-v1-CameraLocationData-mac) | MAC-адрес. # Диапазон: 17..17. # Паттерн: /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/ |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-title"></a> [title](#keyapis-vc-v1-CameraLocationData-title) | Наименование устройства. # Диапазон: 3..256 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-host"></a> [host](#keyapis-vc-v1-CameraLocationData-host) | Сетевой адрес. # Диапазон: 0..250 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-status_type"></a> [status_type](#keyapis-vc-v1-CameraLocationData-status_type) | Статус устройства |    [keyapis.vc.v1.CameraLocationData.StatusType](#keyapis-vc-v1-CameraLocationData-StatusType) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-entrance_numbers"></a> [entrance_numbers](#keyapis-vc-v1-CameraLocationData-entrance_numbers) | Номер подъезда. # Диапазон: 1..100 |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-flatgramm_id"></a> [flatgramm_id](#keyapis-vc-v1-CameraLocationData-flatgramm_id) | Идентификатор квартирограммы. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-company"></a> [company](#keyapis-vc-v1-CameraLocationData-company) | Компания владелец устройства |    [keyapis.vc.v1.CameraLocationData.Company](#keyapis-vc-v1-CameraLocationData-Company) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-buildings"></a> [buildings](#keyapis-vc-v1-CameraLocationData-buildings) | Массив домов камеры |  repeated  [keyapis.vc.v1.CameraLocationData.Building](#keyapis-vc-v1-CameraLocationData-Building) | <nil>|






<a name="keyapis-vc-v1-CameraLocationData-Building"></a>


### [CameraLocationData.Building](#keyapis-vc-v1-CameraLocationData-Building)
 Дом


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraLocationData-Building-id"></a> [id](#keyapis-vc-v1-CameraLocationData-Building-id) | Идентификатор дома |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-rf_id"></a> [rf_id](#keyapis-vc-v1-CameraLocationData-Building-rf_id) | Идентификатор РФ |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-mrf_id"></a> [mrf_id](#keyapis-vc-v1-CameraLocationData-Building-mrf_id) | Идентификатор МРФ |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-orpon"></a> [orpon](#keyapis-vc-v1-CameraLocationData-Building-orpon) | ОРПОН |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-city"></a> [city](#keyapis-vc-v1-CameraLocationData-Building-city) | Город |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-street"></a> [street](#keyapis-vc-v1-CameraLocationData-Building-street) | Улица |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-number"></a> [number](#keyapis-vc-v1-CameraLocationData-Building-number) | Номер дома |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-part"></a> [part](#keyapis-vc-v1-CameraLocationData-Building-part) | Корпус |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-company_id"></a> [company_id](#keyapis-vc-v1-CameraLocationData-Building-company_id) | Идентификатор компании |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-prefix"></a> [prefix](#keyapis-vc-v1-CameraLocationData-Building-prefix) | Префикс |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-created_at"></a> [created_at](#keyapis-vc-v1-CameraLocationData-Building-created_at) | Дата создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-vc-v1-CameraLocationData-Building-deleted_at"></a> [deleted_at](#keyapis-vc-v1-CameraLocationData-Building-deleted_at) | Дата удаления. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-vc-v1-CameraLocationData-Building-flatgramm_id"></a> [flatgramm_id](#keyapis-vc-v1-CameraLocationData-Building-flatgramm_id) | Идентификатор квартирограммы |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-CameraLocationData-Building-city_orpon"></a> [city_orpon](#keyapis-vc-v1-CameraLocationData-Building-city_orpon) | ОРПОН города, в котором находится дом |    [int64](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-fias"></a> [fias](#keyapis-vc-v1-CameraLocationData-Building-fias) | Идентификатор в федеральной информационной адресной системе. Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-district"></a> [district](#keyapis-vc-v1-CameraLocationData-Building-district) | Наименования района. # Диапазон: 0..200 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-unom"></a> [unom](#keyapis-vc-v1-CameraLocationData-Building-unom) | Уникальный номер адреса. # Диапазон: 0..9999999999 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Building-region_orpon"></a> [region_orpon](#keyapis-vc-v1-CameraLocationData-Building-region_orpon) | ОРПОН региона |    [int64](#scalar-types) | <nil>|






<a name="keyapis-vc-v1-CameraLocationData-Company"></a>


### [CameraLocationData.Company](#keyapis-vc-v1-CameraLocationData-Company)
 Компания


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraLocationData-Company-id"></a> [id](#keyapis-vc-v1-CameraLocationData-Company-id) | Идентификатор компании. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Company-vc_company_id"></a> [vc_company_id](#keyapis-vc-v1-CameraLocationData-Company-vc_company_id) | Идентификатор компании в системе Видеокомфорт |    [int64](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Company-name"></a> [name](#keyapis-vc-v1-CameraLocationData-Company-name) | Наименование компании |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Company-inn"></a> [inn](#keyapis-vc-v1-CameraLocationData-Company-inn) | ИНН |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Company-kpp"></a> [kpp](#keyapis-vc-v1-CameraLocationData-Company-kpp) | КПП |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraLocationData-Company-ogrn"></a> [ogrn](#keyapis-vc-v1-CameraLocationData-Company-ogrn) | ОГРН |    [string](#scalar-types) | <nil>|






<a name="keyapis-vc-v1-GetCameraLocationDataRequest"></a>


### [GetCameraLocationDataRequest](#keyapis-vc-v1-GetCameraLocationDataRequest)
 Запрос на получение данных o местонахождении камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraLocationDataRequest-uid"></a> [uid](#keyapis-vc-v1-GetCameraLocationDataRequest-uid) | uid видеопотока камеры |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-vc-v1-GetCameraLocationDataResponse"></a>


### [GetCameraLocationDataResponse](#keyapis-vc-v1-GetCameraLocationDataResponse)
 Ответ на запрос на получение данных o местонахождении камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraLocationDataResponse-data"></a> [data](#keyapis-vc-v1-GetCameraLocationDataResponse-data) | Данные o местонахождении камеры |  optional  [keyapis.vc.v1.CameraLocationData](#keyapis-vc-v1-CameraLocationData) | <nil>|
| <a id="keyapis-vc-v1-GetCameraLocationDataResponse-error"></a> [error](#keyapis-vc-v1-GetCameraLocationDataResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetCameraLocationDataResponse.Error](#keyapis-vc-v1-GetCameraLocationDataResponse-Error) | <nil>|






<a name="keyapis-vc-v1-GetCameraLocationDataResponse-Error"></a>


### [GetCameraLocationDataResponse.Error](#keyapis-vc-v1-GetCameraLocationDataResponse-Error)
 Ошибка запроса


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





 <!-- end messages -->



<a name="keyapis-vc-v1-CameraLocationData-DeviceType"></a>

### [CameraLocationData.DeviceType](#keyapis-vc-v1-CameraLocationData-DeviceType)
 Тип устройства

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-DEVICE_TYPE_UNKNOWN"></a> [DEVICE_TYPE_UNKNOWN](#keyapis-vc-v1-CameraLocationData-DeviceType-DEVICE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-INTERCOM"></a> [INTERCOM](#keyapis-vc-v1-CameraLocationData-DeviceType-INTERCOM) | Домофон |
| 2 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-VIDEOCAMERA"></a> [VIDEOCAMERA](#keyapis-vc-v1-CameraLocationData-DeviceType-VIDEOCAMERA) | Видеокамера |
| 3 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-BARRIER"></a> [BARRIER](#keyapis-vc-v1-CameraLocationData-DeviceType-BARRIER) | Шлагбаум |
| 4 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-GATE"></a> [GATE](#keyapis-vc-v1-CameraLocationData-DeviceType-GATE) | Калитка |
| 5 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-ACCESS_CONTROL_PANEL"></a> [ACCESS_CONTROL_PANEL](#keyapis-vc-v1-CameraLocationData-DeviceType-ACCESS_CONTROL_PANEL) | СКУД |
| 6 | <a id="keyapis-vc-v1-CameraLocationData-DeviceType-OUTDOOR_CAMERA"></a> [OUTDOOR_CAMERA](#keyapis-vc-v1-CameraLocationData-DeviceType-OUTDOOR_CAMERA) | Наружняя видеокамера |




<a name="keyapis-vc-v1-CameraLocationData-StatusType"></a>

### [CameraLocationData.StatusType](#keyapis-vc-v1-CameraLocationData-StatusType)
 Справочник статусов устройства

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-vc-v1-CameraLocationData-StatusType-STATUS_TYPE_UNKNOWN"></a> [STATUS_TYPE_UNKNOWN](#keyapis-vc-v1-CameraLocationData-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-vc-v1-CameraLocationData-StatusType-OFFLINE"></a> [OFFLINE](#keyapis-vc-v1-CameraLocationData-StatusType-OFFLINE) | Не в сети |
| 2 | <a id="keyapis-vc-v1-CameraLocationData-StatusType-ONLINE"></a> [ONLINE](#keyapis-vc-v1-CameraLocationData-StatusType-ONLINE) | В сети |


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