# Протокол

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

- [keyapis/vc/v1/keyapis_vc_archive_minutes_v1.proto](#keyapis_vc_v1_keyapis_vc_archive_minutes_v1-proto)
    - [ArchiveMinutesService](#keyapis-vc-v1-ArchiveMinutesService)
  
    - [ArchiveMinute](#keyapis-vc-v1-ArchiveMinute)
    - [ArchiveMinuteInterval](#keyapis-vc-v1-ArchiveMinuteInterval)
    - [CameraArchiveMinuteIntervals](#keyapis-vc-v1-CameraArchiveMinuteIntervals)
    - [GetArchiveMinutesCompanyCameraChannelRequest](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest)
    - [GetArchiveMinutesCompanyCameraChannelResponse](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse)
    - [GetArchiveMinutesCompanyCameraChannelResponse.Error](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse-Error)
    - [GetArchiveMinutesCompanyCameraChannelTimestampRequest](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest)
    - [GetArchiveMinutesCompanyCameraChannelTimestampResponse](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse)
    - [GetArchiveMinutesCompanyCameraChannelTimestampResponse.Error](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-Error)
    - [GetArchiveMinutesCompanyCameraChannelTimestampResponse.Error.VcfrontServiceError](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-Error-VcfrontServiceError)
  


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




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

## [keyapis/vc/v1/keyapis_vc_archive_minutes_v1.proto](/protos/key/keyapis/vc/v1/keyapis_vc_archive_minutes_v1.proto)
Сервис управления архивными минутками


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

### ArchiveMinutesService
 Сервис управления архивными минутками

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannel"></a> [GetArchiveMinutesCompanyCameraChannel](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannel) | Метод получения архивных минуток для канала камеры компании. Метод доступен для: admin, service, bti | [keyapis.vc.v1.GetArchiveMinutesCompanyCameraChannelRequest](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest) | [keyapis.vc.v1.GetArchiveMinutesCompanyCameraChannelResponse](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse) |
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestamp"></a> [GetArchiveMinutesCompanyCameraChannelTimestamp](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestamp) | Метод получения информации об архивной минутке для канала камеры компании по метке времени. Метод доступен для: admin, service, bti | [keyapis.vc.v1.GetArchiveMinutesCompanyCameraChannelTimestampRequest](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest) | [keyapis.vc.v1.GetArchiveMinutesCompanyCameraChannelTimestampResponse](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse) |

 <!-- end services -->


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


### [ArchiveMinute](#keyapis-vc-v1-ArchiveMinute)
 Информация об архивной минутке


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-ArchiveMinute-company_id"></a> [company_id](#keyapis-vc-v1-ArchiveMinute-company_id) | Идентификатор компании |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-ArchiveMinute-camera_uid"></a> [camera_uid](#keyapis-vc-v1-ArchiveMinute-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-ArchiveMinute-channel_uid"></a> [channel_uid](#keyapis-vc-v1-ArchiveMinute-channel_uid) | Идентификатор канала |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-ArchiveMinute-data"></a> [data](#keyapis-vc-v1-ArchiveMinute-data) | Границы архивной минутки |    [keyapis.vc.v1.ArchiveMinuteInterval](#keyapis-vc-v1-ArchiveMinuteInterval) | <nil>|
| <a id="keyapis-vc-v1-ArchiveMinute-size"></a> [size](#keyapis-vc-v1-ArchiveMinute-size) | Размер |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-ArchiveMinute-md5"></a> [md5](#keyapis-vc-v1-ArchiveMinute-md5) | Хэш md5 |    [string](#scalar-types) | <nil>|






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


### [ArchiveMinuteInterval](#keyapis-vc-v1-ArchiveMinuteInterval)
 Интервал архивной минутки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-ArchiveMinuteInterval-since_timestamp"></a> [since_timestamp](#keyapis-vc-v1-ArchiveMinuteInterval-since_timestamp) | Начало минутки. Дата в формате Unix. Пример 1598269021.755 |    [double](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-ArchiveMinuteInterval-till_timestamp"></a> [till_timestamp](#keyapis-vc-v1-ArchiveMinuteInterval-till_timestamp) | Конец минутки. Дата в формате Unix. Пример 1598269021.755 |    [double](#scalar-types) | <nil>|






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


### [CameraArchiveMinuteIntervals](#keyapis-vc-v1-CameraArchiveMinuteIntervals)
 Интервалы архивных минуток камеры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraArchiveMinuteIntervals-available"></a> [available](#keyapis-vc-v1-CameraArchiveMinuteIntervals-available) | Доступные минутки |  repeated  [keyapis.vc.v1.ArchiveMinuteInterval](#keyapis-vc-v1-ArchiveMinuteInterval) | <nil>|
| <a id="keyapis-vc-v1-CameraArchiveMinuteIntervals-frozen"></a> [frozen](#keyapis-vc-v1-CameraArchiveMinuteIntervals-frozen) | Замороженные минутки |  repeated  [keyapis.vc.v1.ArchiveMinuteInterval](#keyapis-vc-v1-ArchiveMinuteInterval) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-company_id"></a> [company_id](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-company_id) | Идентификатор компании. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-camera_uid"></a> [camera_uid](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-channel_uid"></a> [channel_uid](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-channel_uid) | Идентификатор канала |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-since_timestamp"></a> [since_timestamp](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-since_timestamp) | Начало промежутка минуток. Дата в формате Unix. Пример 1598269021.755. # Не превышает: till_timestamp |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-till_timestamp"></a> [till_timestamp](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelRequest-till_timestamp) | Конец промежутка минуток. Дата в формате Unix. Пример 1598269021.755 |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse-data"></a> [data](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse-data) | Архивные минутки компании |  optional  [keyapis.vc.v1.CameraArchiveMinuteIntervals](#keyapis-vc-v1-CameraArchiveMinuteIntervals) | <nil>|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse-error"></a> [error](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetArchiveMinutesCompanyCameraChannelResponse.Error](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelResponse-Error) | <nil>|






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


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


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






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


### [GetArchiveMinutesCompanyCameraChannelTimestampRequest](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest)
 Запрос получения информации об архивной минутке для канала камеры компании


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-company_id"></a> [company_id](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-company_id) | Идентификатор компании. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-camera_uid"></a> [camera_uid](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-channel_uid"></a> [channel_uid](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-channel_uid) | Идентификатор канала |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-timestamp_value"></a> [timestamp_value](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampRequest-timestamp_value) | Метка времени архивной минутки. Берется та минутка, которая попадает этой меткой времени в границы интервала архивной архивной минутки. Дата в формате Unix. Пример 1598269021 |    [int64](#scalar-types) | REQUIRED|






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


### [GetArchiveMinutesCompanyCameraChannelTimestampResponse](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse)
 Ответ на запрос получения информации об архивной минутке для канала камеры компании


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-data"></a> [data](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-data) | Информация об архивной минутке |  optional  [keyapis.vc.v1.ArchiveMinute](#keyapis-vc-v1-ArchiveMinute) | <nil>|
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-error"></a> [error](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetArchiveMinutesCompanyCameraChannelTimestampResponse.Error](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-Error) | <nil>|






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


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


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






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


### [GetArchiveMinutesCompanyCameraChannelTimestampResponse.Error.VcfrontServiceError](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-Error-VcfrontServiceError)
 Ошибка взаимодействия с сервисом vcfront


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-Error-VcfrontServiceError-text"></a> [text](#keyapis-vc-v1-GetArchiveMinutesCompanyCameraChannelTimestampResponse-Error-VcfrontServiceError-text) | Текст ошибки |    [string](#scalar-types) | <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 |

