# Протокол

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

- [keyapis/vc/v1/keyapis_vc_camera_archive_v1.proto](#keyapis_vc_v1_keyapis_vc_camera_archive_v1-proto)
    - [CameraArchiveService](#keyapis-vc-v1-CameraArchiveService)
  
    - [CameraArchiveCalendar](#keyapis-vc-v1-CameraArchiveCalendar)
    - [CameraArchiveIntervals](#keyapis-vc-v1-CameraArchiveIntervals)
    - [GetCameraArchiveCalendarRequest](#keyapis-vc-v1-GetCameraArchiveCalendarRequest)
    - [GetCameraArchiveCalendarResponse](#keyapis-vc-v1-GetCameraArchiveCalendarResponse)
    - [GetCameraArchiveCalendarResponse.Error](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error)
    - [GetCameraArchiveCalendarResponse.Error.VcError](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-VcError)
    - [GetCameraArchiveCalendarResponse.Error.VcUserNotFound](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-VcUserNotFound)
    - [GetCameraArchiveIntervalsRequest](#keyapis-vc-v1-GetCameraArchiveIntervalsRequest)
    - [GetCameraArchiveIntervalsResponse](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse)
    - [GetCameraArchiveIntervalsResponse.Error](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error)
    - [GetCameraArchiveIntervalsResponse.Error.VcError](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-VcError)
    - [GetCameraArchiveIntervalsResponse.Error.VcUserNotFound](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-VcUserNotFound)
    - [Interval](#keyapis-vc-v1-Interval)
  


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




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

## [keyapis/vc/v1/keyapis_vc_camera_archive_v1.proto](/protos/key/keyapis/vc/v1/keyapis_vc_camera_archive_v1.proto)
Спецификация архивных записей камеры


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

### CameraArchiveService
 Сервис архивных записей камеры

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-vc-v1-GetCameraArchiveCalendar"></a> [GetCameraArchiveCalendar](#keyapis-vc-v1-GetCameraArchiveCalendar) | Метод получения доступных дней с видеоархивом камеры. При обращении к ВН берется идентификатор пользователя из токена. Метод доступен для: admin, service, bti, mrf, ltp_first, master, owner, employee, seller, external_seller | [keyapis.vc.v1.GetCameraArchiveCalendarRequest](#keyapis-vc-v1-GetCameraArchiveCalendarRequest) | [keyapis.vc.v1.GetCameraArchiveCalendarResponse](#keyapis-vc-v1-GetCameraArchiveCalendarResponse) |
| <a id="keyapis-vc-v1-GetCameraArchiveIntervals"></a> [GetCameraArchiveIntervals](#keyapis-vc-v1-GetCameraArchiveIntervals) | Метод получения доступных интервалов видеоархива камеры. При обращении к ВН берется идентификатор пользователя из токена. Метод доступен для: admin, service, bti, mrf, ltp_first, master, owner, employee, seller, external_seller | [keyapis.vc.v1.GetCameraArchiveIntervalsRequest](#keyapis-vc-v1-GetCameraArchiveIntervalsRequest) | [keyapis.vc.v1.GetCameraArchiveIntervalsResponse](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse) |

 <!-- end services -->


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


### [CameraArchiveCalendar](#keyapis-vc-v1-CameraArchiveCalendar)
 Календарь с датами, в которые есть записи


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraArchiveCalendar-camera_uid"></a> [camera_uid](#keyapis-vc-v1-CameraArchiveCalendar-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraArchiveCalendar-dates"></a> [dates](#keyapis-vc-v1-CameraArchiveCalendar-dates) | Список дней, за которые есть записи. Строки в формате "YYYY-MM-DD" |  repeated  [string](#scalar-types) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-CameraArchiveIntervals-camera_uid"></a> [camera_uid](#keyapis-vc-v1-CameraArchiveIntervals-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-CameraArchiveIntervals-intervals"></a> [intervals](#keyapis-vc-v1-CameraArchiveIntervals-intervals) | Список интервалов видеоархива камеры |  repeated  [keyapis.vc.v1.Interval](#keyapis-vc-v1-Interval) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarRequest-camera_uid"></a> [camera_uid](#keyapis-vc-v1-GetCameraArchiveCalendarRequest-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarRequest-utc_offset"></a> [utc_offset](#keyapis-vc-v1-GetCameraArchiveCalendarRequest-utc_offset) | Смещение таймзоны в минутах. # Диапазон: -720..840 |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarResponse-data"></a> [data](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-data) | Календарь с датами, в которые есть записи |  optional  [keyapis.vc.v1.CameraArchiveCalendar](#keyapis-vc-v1-CameraArchiveCalendar) | <nil>|
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarResponse-error"></a> [error](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetCameraArchiveCalendarResponse.Error](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-validation"></a> [validation](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.vc.v1.ValidationError](#keyapis-vc-v1-ValidationError) | <nil>|
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-vc_error"></a> [vc_error](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-vc_error) | Ошибка в сервисе ВН |  optional  [keyapis.vc.v1.GetCameraArchiveCalendarResponse.Error.VcError](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-VcError) | <nil>|
| <a id="keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-vc_user_not_found"></a> [vc_user_not_found](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-vc_user_not_found) | Отсутствует идентификатор пользователя в Видеоплатформе |  optional  [keyapis.vc.v1.GetCameraArchiveCalendarResponse.Error.VcUserNotFound](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-VcUserNotFound) | <nil>|






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


### [GetCameraArchiveCalendarResponse.Error.VcError](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-VcError)
 Ошибка в сервисе ВН


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






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


### [GetCameraArchiveCalendarResponse.Error.VcUserNotFound](#keyapis-vc-v1-GetCameraArchiveCalendarResponse-Error-VcUserNotFound)
 Отсутствует идентификатор пользователя в Видеоплатформе






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraArchiveIntervalsRequest-camera_uid"></a> [camera_uid](#keyapis-vc-v1-GetCameraArchiveIntervalsRequest-camera_uid) | Идентификатор камеры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-vc-v1-GetCameraArchiveIntervalsRequest-timestamp_since"></a> [timestamp_since](#keyapis-vc-v1-GetCameraArchiveIntervalsRequest-timestamp_since) | Время с которого нужно получить интервалы архива unixtime |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-vc-v1-GetCameraArchiveIntervalsRequest-timestamp_till"></a> [timestamp_till](#keyapis-vc-v1-GetCameraArchiveIntervalsRequest-timestamp_till) | Время по которое нужно получить интервалы архива unixtime |    [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






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


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


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






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-validation"></a> [validation](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.vc.v1.ValidationError](#keyapis-vc-v1-ValidationError) | <nil>|
| <a id="keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-vc_error"></a> [vc_error](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-vc_error) | Ошибка в сервисе ВН |  optional  [keyapis.vc.v1.GetCameraArchiveIntervalsResponse.Error.VcError](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-VcError) | <nil>|
| <a id="keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-vc_user_not_found"></a> [vc_user_not_found](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-vc_user_not_found) | Отсутствует идентификатор пользователя в Видеоплатформе |  optional  [keyapis.vc.v1.GetCameraArchiveIntervalsResponse.Error.VcUserNotFound](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-VcUserNotFound) | <nil>|






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


### [GetCameraArchiveIntervalsResponse.Error.VcError](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-VcError)
 Ошибка в сервисе ВН


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






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


### [GetCameraArchiveIntervalsResponse.Error.VcUserNotFound](#keyapis-vc-v1-GetCameraArchiveIntervalsResponse-Error-VcUserNotFound)
 Отсутствует идентификатор пользователя в Видеоплатформе






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


### [Interval](#keyapis-vc-v1-Interval)
 Интервал


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-Interval-timestamp_begin"></a> [timestamp_begin](#keyapis-vc-v1-Interval-timestamp_begin) | Начало интервала unixtime |    [double](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Interval-timestamp_end"></a> [timestamp_end](#keyapis-vc-v1-Interval-timestamp_end) | Конец интервала unixtime |    [double](#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 |