Протокол¶
Оглавление¶
-
keyapis/vc/v1/keyapis_vc_camera_v1.proto
- Camera.ValidationError
- Camera.ValidationError.OneFieldMacOrSerialNumberRequired
- Camera.ValidationError.RtspUrlRequired
- CameraFilter
- CameraPaging
- CameraRoom
- CameraRoomFilter
- CameraRoomPaging
- CameraScope
- DeleteCameraRequest
- DeleteCameraResponse
- DeleteCameraResponse.Error
- GetCameraListRequest
- GetCameraListResponse
- GetCameraListResponse.Data
- GetCameraListResponse.Error
- GetCameraRequest
- GetCameraResponse
- GetCameraResponse.Error
- GetCameraRoomCountRequest
- GetCameraRoomCountResponse
- GetCameraRoomCountResponse.Error
- GetCameraRoomListRequest
- GetCameraRoomListResponse
- GetCameraRoomListResponse.Error
- GetCameraRtspUrlExternalIdRequest
- GetCameraRtspUrlExternalIdResponse
- GetCameraRtspUrlExternalIdResponse.CameraRtspUrl
- GetCameraRtspUrlExternalIdResponse.Error
- PostCameraRequest
- PostCameraResponse
- PostCameraResponse.Error
- PostCameraResponse.Error.VcError
- PutCameraRoomAttachListRequest
- PutCameraRoomAttachListResponse
- PutCameraRoomAttachListResponse.Error
- PutCameraRoomAttachRequest
- PutCameraRoomAttachResponse
- PutCameraRoomAttachResponse.Error
- PutCameraRoomDetachListRequest
- PutCameraRoomDetachListResponse
- PutCameraRoomDetachListResponse.Error
- PutCameraRoomDetachRequest
- PutCameraRoomDetachResponse
- PutCameraRoomDetachResponse.Error
- CameraPaging.DirectionType
- CameraPaging.OrderByType
- CameraRoomPaging.DirectionType
- CameraRoomPaging.OrderByType
Схема классов¶
keyapis/vc/v1/keyapis_vc_camera_v1.proto¶
Сервис работы с камерами
CameraService¶
Сервис работы с камерами
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetCameraRoomCount | Метод получения количества связей камеры и квартиры. Метод доступен для: admin, service, bti, owner, employee | keyapis.vc.v1.GetCameraRoomCountRequest | keyapis.vc.v1.GetCameraRoomCountResponse |
| GetCameraRoomList | Метод получения списка связей камеры и квартиры. Метод доступен для: admin, service, bti, owner, employee | keyapis.vc.v1.GetCameraRoomListRequest | keyapis.vc.v1.GetCameraRoomListResponse stream |
| GetCamera | Метод получения камеры. Для owner, employee параметр scope.vc_company_id подставляется из токена. Метод доступен для: admin, service, bti, ltp_first, owner, employee | keyapis.vc.v1.GetCameraRequest | keyapis.vc.v1.GetCameraResponse |
| GetCameraList | Метод получения списка камер. Для owner, employee параметр scope.vc_company_id подставляется из токена. Метод доступен для: admin, service, bti, ltp_first, owner, employee | keyapis.vc.v1.GetCameraListRequest | keyapis.vc.v1.GetCameraListResponse |
| GetCameraRtspUrlExternalId | Метод получения RTSP-ссылки по идентификатору камеры в vcfront. Метод доступен для: admin, service. Метод доступен для: ApiKey | keyapis.vc.v1.GetCameraRtspUrlExternalIdRequest | keyapis.vc.v1.GetCameraRtspUrlExternalIdResponse |
| PutCameraRoomAttach | Метод привязки камеры и квартиры. Метод доступен для: admin, service, bti, owner, employee | keyapis.vc.v1.PutCameraRoomAttachRequest | keyapis.vc.v1.PutCameraRoomAttachResponse |
| PutCameraRoomDetach | Метод отвязки камеры и квартиры. Метод доступен для: admin, service, bti, owner, employee | keyapis.vc.v1.PutCameraRoomDetachRequest | keyapis.vc.v1.PutCameraRoomDetachResponse |
| PutCameraRoomAttachList | Метод пакетной привязки камер и квартир. Метод доступен для: admin, service, bti, owner, employee | keyapis.vc.v1.PutCameraRoomAttachListRequest | keyapis.vc.v1.PutCameraRoomAttachListResponse |
| PutCameraRoomDetachList | Метод пакетной отвязки камер и квартир. Метод доступен для: admin, service, bti, owner, employee | keyapis.vc.v1.PutCameraRoomDetachListRequest | keyapis.vc.v1.PutCameraRoomDetachListResponse |
| DeleteCamera | Метод удаления камеры. Метод доступен для: admin, service, bti | keyapis.vc.v1.DeleteCameraRequest | keyapis.vc.v1.DeleteCameraResponse |
| PostCamera | Метод создания камеры. Метод доступен для: admin, service, bti | keyapis.vc.v1.PostCameraRequest | keyapis.vc.v1.PostCameraResponse |
Camera¶
Камера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор камеры | string | OUTPUT_ONLY |
| uid | uid камеры | string | OUTPUT_ONLY |
| name | Название камеры | string | OUTPUT_ONLY |
| is_online | Признак: онлайн камера или нет | bool | OUTPUT_ONLY |
| is_active_user_camera | Признак: Есть ли у камеры активный пользователь | bool | OUTPUT_ONLY |
| status_changed_at | Дата и время изменения статуса камеры | google.protobuf.Timestamp | OUTPUT_ONLY |
| mac | MAC-адрес камеры | string | |
| ip | IP камеры | string | OUTPUT_ONLY |
| remote_ip | Внешний IP камеры | string | OUTPUT_ONLY |
| tariff_started_at | Дата начала действия текущего тарифа | google.protobuf.Timestamp | OUTPUT_ONLY |
| tariff_ended_at | Дата окончания действия текущего тарифа | google.protobuf.Timestamp | OUTPUT_ONLY |
| tariff_title | Наименование тарифа | string | OUTPUT_ONLY |
| type | Тип камеры | keyapis.vc.v1.Camera.Type | INPUT_ONLY |
| camera_category_id | Идентификатор категории. Камера - 1, домофон - 2, скуд - 3, шлагбаум - 4 | int32 | INPUT_ONLY |
| rtsp_url | РТСП-ссылка | string | INPUT_ONLY |
| serial_number | Серийный номер | string | INPUT_ONLY |
| company_id | Идентификатор компании | int32 | INPUT_ONLY |
Camera.ValidationError¶
Ошибки валидации
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| rtsp_url_required | Поле rtsp_url должно быть заполнено | optional keyapis.vc.v1.Camera.ValidationError.RtspUrlRequired | |
| one_field_mac_or_serial_number_required | Только одно поле обязательно к заполнению mac или serial_number | optional keyapis.vc.v1.Camera.ValidationError.OneFieldMacOrSerialNumberRequired |
Camera.ValidationError.OneFieldMacOrSerialNumberRequired¶
Только одно поле обязательно к заполнению mac или serial_number. Для камер с типом VIOLET и DVR
Camera.ValidationError.RtspUrlRequired¶
Поле rtsp_url должно быть заполнено. Только для камер с типом ROSE
CameraFilter¶
Фильтр камер
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| is_active | Признак активности камеры | google.protobuf.BoolValue | |
| is_channel_alive | Признак активности канала | google.protobuf.BoolValue | |
| is_online | Статус камеры | google.protobuf.BoolValue | |
| camera_type | Тип камеры | keyapis.vc.v1.Camera.Type |
CameraPaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию | keyapis.vc.v1.CameraPaging.OrderByType | |
| direction_type | Тип направления сортировки. # По умолчанию: DESC | keyapis.vc.v1.CameraPaging.DirectionType | |
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
CameraRoom¶
Связь камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| camera_uid | Идентификатор камеры | string | REQUIRED |
| orpon | ОРПОН дома | int64 | REQUIRED |
| room_number | Номер квартиры. # Диапазон: 1..4 | string | REQUIRED |
CameraRoomFilter¶
Фильтр связок камеры и квартиры. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| camera_uids | По Идентификаторам камер. # Диапазон: 0..100 | repeated string | |
| orpons | По ОРПОНам. # Диапазон: 0..100 | repeated int64 | |
| room_numbers | По квартирам. # Диапазон: 0..100 | repeated string |
CameraRoomPaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию CAMERA_UID | keyapis.vc.v1.CameraRoomPaging.OrderByType | |
| direction_type | Тип направления сортировки. # По умолчанию: DESC | keyapis.vc.v1.CameraRoomPaging.DirectionType | |
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
CameraScope¶
Ограничение выборки камер
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| vc_company_id | Внешний идентификатор компании | int32 |
DeleteCameraRequest¶
Запрос удаления камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| uid | Идентификатор камеры в vcfront. # Тип: Guid | string | REQUIRED |
| is_delete_permanently | Флаг полного (безвозвратного) удаления камеры | bool |
DeleteCameraResponse¶
Ответ на запрос удаления камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.vc.v1.DeleteCameraResponse.Error |
DeleteCameraResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
GetCameraListRequest¶
Запрос на получение списка камер
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| scope | Ограничение выборки | keyapis.vc.v1.CameraScope | |
| filter | Фильтр | keyapis.vc.v1.CameraFilter | |
| paging | Постраничный вывод | optional keyapis.vc.v1.CameraPaging |
GetCameraListResponse¶
Ответ на получение списка камер
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список | optional keyapis.vc.v1.GetCameraListResponse.Data | |
| error | Ошибка | optional keyapis.vc.v1.GetCameraListResponse.Error |
GetCameraListResponse.Data¶
Список
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| items | Список Camera | repeated keyapis.vc.v1.Camera | |
| total | Всего количество | int32 |
GetCameraListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
GetCameraRequest¶
Запрос получения камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| scope | Ограничение выборки | keyapis.vc.v1.CameraScope | REQUIRED |
| uid | uid камеры | string | REQUIRED |
GetCameraResponse¶
Ответ на запрос получения камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Камера | optional keyapis.vc.v1.Camera | |
| error | Ошибка | optional keyapis.vc.v1.GetCameraResponse.Error |
GetCameraResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
GetCameraRoomCountRequest¶
Запрос получения количества связей камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.vc.v1.CameraRoomFilter |
GetCameraRoomCountResponse¶
Ответ получения количества связей камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество | optional int32 | |
| error | Ошибка | optional keyapis.vc.v1.GetCameraRoomCountResponse.Error |
GetCameraRoomCountResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
GetCameraRoomListRequest¶
Запрос получения списка связей камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.vc.v1.CameraRoomFilter | |
| paging | Постраничный вывод | optional keyapis.vc.v1.CameraRoomPaging |
GetCameraRoomListResponse¶
Ответ получения списка связей камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Связь камеры и квартиры | optional keyapis.vc.v1.CameraRoom | |
| error | Ошибка | optional keyapis.vc.v1.GetCameraRoomListResponse.Error |
GetCameraRoomListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
GetCameraRtspUrlExternalIdRequest¶
Запрос получения камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| external_id | Идентификатор камеры в vcfront. # Тип: Guid | string | REQUIRED |
GetCameraRtspUrlExternalIdResponse¶
Ответ на запрос получения RTSP-ссылки по идентификатору камеры в vcfront
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | RTSP-ссылка | optional keyapis.vc.v1.GetCameraRtspUrlExternalIdResponse.CameraRtspUrl | |
| error | Ошибка | optional keyapis.vc.v1.GetCameraRtspUrlExternalIdResponse.Error |
GetCameraRtspUrlExternalIdResponse.CameraRtspUrl¶
RTSP-ссылка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| rtsp_url | RTSP-ссылка | string |
GetCameraRtspUrlExternalIdResponse.Error¶
Ошибка запроса получения списка камер
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
PostCameraRequest¶
Запрос создания камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Камера | keyapis.vc.v1.Camera | REQUIRED |
PostCameraResponse¶
Ответ на запрос создания камеры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.vc.v1.PostCameraResponse.Error |
PostCameraResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError | |
| camera_validation | Ошибка валидации | optional keyapis.vc.v1.Camera.ValidationError | |
| vc | Ошибка в сервисе ВН | optional keyapis.vc.v1.PostCameraResponse.Error.VcError |
PostCameraResponse.Error.VcError¶
Ошибка в сервисе ВН
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| text | Текст ошибки | string |
PutCameraRoomAttachListRequest¶
Запрос пакетной привязки камер и квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Массив связей Camera и Room | repeated keyapis.vc.v1.CameraRoom |
PutCameraRoomAttachListResponse¶
Ответ на запрос пакетной привязки камер и квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.vc.v1.PutCameraRoomAttachListResponse.Error |
PutCameraRoomAttachListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
PutCameraRoomAttachRequest¶
Запрос привязки камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Связь Camera и Room | keyapis.vc.v1.CameraRoom | REQUIRED |
PutCameraRoomAttachResponse¶
Ответ привязки камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.vc.v1.PutCameraRoomAttachResponse.Error |
PutCameraRoomAttachResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
PutCameraRoomDetachListRequest¶
Запрос пакетной отвязки камер и квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Массив связей Camera и Room | repeated keyapis.vc.v1.CameraRoom |
PutCameraRoomDetachListResponse¶
Ответ на запрос пакетной отвязки камер и квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.vc.v1.PutCameraRoomDetachListResponse.Error |
PutCameraRoomDetachListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
PutCameraRoomDetachRequest¶
Запрос отвязки камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Связь Camera и Room | keyapis.vc.v1.CameraRoom | REQUIRED |
PutCameraRoomDetachResponse¶
Ответ отвязки камеры и квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.vc.v1.PutCameraRoomDetachResponse.Error |
PutCameraRoomDetachResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.vc.v1.ValidationError |
ValidationError¶
Ошибки валидации. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| path | Путь к полю в формате наименования прото | string | REQUIRED |
| message | Валидационное сообщение | string | REQUIRED |
Camera.Type¶
Справочник типов камер
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | DVR | Регистратор |
| 2 | VMS | Система управления видео |
| 3 | ROSE | RTSP-камера |
| 4 | VIOLET | IP-камера |
CameraPaging.DirectionType¶
Справочник типов направлений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
CameraPaging.OrderByType¶
Справочник типов значений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | UID | По идентификатору |
CameraRoomPaging.DirectionType¶
Справочник типов направлений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
CameraRoomPaging.OrderByType¶
Справочник типов значений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | CAMERA_UID | По Идентификатору камеры |
| 2 | ORPON_ROOM_NUMBER | По ОРПОН и номеру квартиры |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | 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 | 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 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | 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 | 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 | 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 | 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 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |