# Протокол

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

- [keyapis/vc/v1/keyapis_vc_camera_dictionary_v1.proto](#keyapis_vc_v1_keyapis_vc_camera_dictionary_v1-proto)
    - [DictionaryService](#keyapis-vc-v1-DictionaryService)
  
    - [Category](#keyapis-vc-v1-Category)
    - [GetDictionaryCategoriesRequest](#keyapis-vc-v1-GetDictionaryCategoriesRequest)
    - [GetDictionaryCategoriesResponse](#keyapis-vc-v1-GetDictionaryCategoriesResponse)
    - [GetDictionaryCategoriesResponse.CameraCategories](#keyapis-vc-v1-GetDictionaryCategoriesResponse-CameraCategories)
    - [GetDictionaryCategoriesResponse.Error](#keyapis-vc-v1-GetDictionaryCategoriesResponse-Error)
    - [GetDictionaryRolesRequest](#keyapis-vc-v1-GetDictionaryRolesRequest)
    - [GetDictionaryRolesResponse](#keyapis-vc-v1-GetDictionaryRolesResponse)
    - [GetDictionaryRolesResponse.Error](#keyapis-vc-v1-GetDictionaryRolesResponse-Error)
    - [GetDictionaryRolesResponse.Roles](#keyapis-vc-v1-GetDictionaryRolesResponse-Roles)
    - [GetDictionaryTariffsRequest](#keyapis-vc-v1-GetDictionaryTariffsRequest)
    - [GetDictionaryTariffsResponse](#keyapis-vc-v1-GetDictionaryTariffsResponse)
    - [GetDictionaryTariffsResponse.CameraTariffs](#keyapis-vc-v1-GetDictionaryTariffsResponse-CameraTariffs)
    - [GetDictionaryTariffsResponse.Error](#keyapis-vc-v1-GetDictionaryTariffsResponse-Error)
    - [Role](#keyapis-vc-v1-Role)
    - [Tariff](#keyapis-vc-v1-Tariff)
    - [VcDictionaryError](#keyapis-vc-v1-VcDictionaryError)
    - [VcDictionaryError.Reason](#keyapis-vc-v1-VcDictionaryError-Reason)
  


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




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

## [keyapis/vc/v1/keyapis_vc_camera_dictionary_v1.proto](/protos/key/keyapis/vc/v1/keyapis_vc_camera_dictionary_v1.proto)
Сервис работы со справочниками атрибутов камер


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

### DictionaryService
 Сервис работы со справочниками атрибутов камер

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-vc-v1-GetDictionaryCategories"></a> [GetDictionaryCategories](#keyapis-vc-v1-GetDictionaryCategories) | Метод получения справочника категорий. Метод доступен для: admin, service, bti, owner, employee | [keyapis.vc.v1.GetDictionaryCategoriesRequest](#keyapis-vc-v1-GetDictionaryCategoriesRequest) | [keyapis.vc.v1.GetDictionaryCategoriesResponse](#keyapis-vc-v1-GetDictionaryCategoriesResponse) |
| <a id="keyapis-vc-v1-GetDictionaryTariffs"></a> [GetDictionaryTariffs](#keyapis-vc-v1-GetDictionaryTariffs) | Метод получения справочника тарифов. Метод доступен для: admin, service, bti, owner, employee | [keyapis.vc.v1.GetDictionaryTariffsRequest](#keyapis-vc-v1-GetDictionaryTariffsRequest) | [keyapis.vc.v1.GetDictionaryTariffsResponse](#keyapis-vc-v1-GetDictionaryTariffsResponse) |
| <a id="keyapis-vc-v1-GetDictionaryRoles"></a> [GetDictionaryRoles](#keyapis-vc-v1-GetDictionaryRoles) | Метод получения справочника ролей. Метод доступен для: admin, service, bti, owner, employee | [keyapis.vc.v1.GetDictionaryRolesRequest](#keyapis-vc-v1-GetDictionaryRolesRequest) | [keyapis.vc.v1.GetDictionaryRolesResponse](#keyapis-vc-v1-GetDictionaryRolesResponse) |

 <!-- end services -->


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


### [Category](#keyapis-vc-v1-Category)
 Категория


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-Category-id"></a> [id](#keyapis-vc-v1-Category-id) | Идентификатор |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Category-title"></a> [title](#keyapis-vc-v1-Category-title) | Наименование |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Category-kind"></a> [kind](#keyapis-vc-v1-Category-kind) | Тип |    [string](#scalar-types) | <nil>|






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


### [GetDictionaryCategoriesRequest](#keyapis-vc-v1-GetDictionaryCategoriesRequest)
 Запрос на получение справочника категорий






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


### [GetDictionaryCategoriesResponse](#keyapis-vc-v1-GetDictionaryCategoriesResponse)
 Ответ на запрос получения справочника категорий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetDictionaryCategoriesResponse-data"></a> [data](#keyapis-vc-v1-GetDictionaryCategoriesResponse-data) | Список категорий |  optional  [keyapis.vc.v1.GetDictionaryCategoriesResponse.CameraCategories](#keyapis-vc-v1-GetDictionaryCategoriesResponse-CameraCategories) | <nil>|
| <a id="keyapis-vc-v1-GetDictionaryCategoriesResponse-error"></a> [error](#keyapis-vc-v1-GetDictionaryCategoriesResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetDictionaryCategoriesResponse.Error](#keyapis-vc-v1-GetDictionaryCategoriesResponse-Error) | <nil>|






<a name="keyapis-vc-v1-GetDictionaryCategoriesResponse-CameraCategories"></a>


### [GetDictionaryCategoriesResponse.CameraCategories](#keyapis-vc-v1-GetDictionaryCategoriesResponse-CameraCategories)
 Список категорий


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetDictionaryCategoriesResponse-CameraCategories-category"></a> [category](#keyapis-vc-v1-GetDictionaryCategoriesResponse-CameraCategories-category) | Категория |  repeated  [keyapis.vc.v1.Category](#keyapis-vc-v1-Category) | <nil>|






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


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


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






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


### [GetDictionaryRolesRequest](#keyapis-vc-v1-GetDictionaryRolesRequest)
 Запрос на получение справочника ролей






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


### [GetDictionaryRolesResponse](#keyapis-vc-v1-GetDictionaryRolesResponse)
 Ответ на запрос получения справочника ролей


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






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


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


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






<a name="keyapis-vc-v1-GetDictionaryRolesResponse-Roles"></a>


### [GetDictionaryRolesResponse.Roles](#keyapis-vc-v1-GetDictionaryRolesResponse-Roles)
 Список ролей


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetDictionaryRolesResponse-Roles-roles"></a> [roles](#keyapis-vc-v1-GetDictionaryRolesResponse-Roles-roles) | Роли |  repeated  [keyapis.vc.v1.Role](#keyapis-vc-v1-Role) | <nil>|






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


### [GetDictionaryTariffsRequest](#keyapis-vc-v1-GetDictionaryTariffsRequest)
 Запрос на получение справочника тарифов






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


### [GetDictionaryTariffsResponse](#keyapis-vc-v1-GetDictionaryTariffsResponse)
 Ответ на запрос получения справочника тарифов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetDictionaryTariffsResponse-data"></a> [data](#keyapis-vc-v1-GetDictionaryTariffsResponse-data) | Список тарифов |  optional  [keyapis.vc.v1.GetDictionaryTariffsResponse.CameraTariffs](#keyapis-vc-v1-GetDictionaryTariffsResponse-CameraTariffs) | <nil>|
| <a id="keyapis-vc-v1-GetDictionaryTariffsResponse-error"></a> [error](#keyapis-vc-v1-GetDictionaryTariffsResponse-error) | Ошибка |  optional  [keyapis.vc.v1.GetDictionaryTariffsResponse.Error](#keyapis-vc-v1-GetDictionaryTariffsResponse-Error) | <nil>|






<a name="keyapis-vc-v1-GetDictionaryTariffsResponse-CameraTariffs"></a>


### [GetDictionaryTariffsResponse.CameraTariffs](#keyapis-vc-v1-GetDictionaryTariffsResponse-CameraTariffs)
 Список тарифов


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-GetDictionaryTariffsResponse-CameraTariffs-tariff"></a> [tariff](#keyapis-vc-v1-GetDictionaryTariffsResponse-CameraTariffs-tariff) | Тариф |  repeated  [keyapis.vc.v1.Tariff](#keyapis-vc-v1-Tariff) | <nil>|






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


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


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






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


### [Role](#keyapis-vc-v1-Role)
 Роль


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-Role-id"></a> [id](#keyapis-vc-v1-Role-id) | Идентификатор |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Role-title"></a> [title](#keyapis-vc-v1-Role-title) | Наименование |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Role-permissions"></a> [permissions](#keyapis-vc-v1-Role-permissions) | Доступы |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Role-is_global"></a> [is_global](#keyapis-vc-v1-Role-is_global) | Является ли роль глобальной |    [bool](#scalar-types) | <nil>|






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


### [Tariff](#keyapis-vc-v1-Tariff)
 Тариф


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-Tariff-id"></a> [id](#keyapis-vc-v1-Tariff-id) | Идентификатор |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Tariff-title"></a> [title](#keyapis-vc-v1-Tariff-title) | Наименование |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Tariff-slug"></a> [slug](#keyapis-vc-v1-Tariff-slug) | Параметр slug |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Tariff-status_kind"></a> [status_kind](#keyapis-vc-v1-Tariff-status_kind) | Тип статуса |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-Tariff-from_at"></a> [from_at](#keyapis-vc-v1-Tariff-from_at) | Дата действия от. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-vc-v1-Tariff-to_at"></a> [to_at](#keyapis-vc-v1-Tariff-to_at) | Дата действия до. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






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


### [VcDictionaryError](#keyapis-vc-v1-VcDictionaryError)
 Ошибка VCfront


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-VcDictionaryError-service"></a> [service](#keyapis-vc-v1-VcDictionaryError-service) | Сервис |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-VcDictionaryError-product"></a> [product](#keyapis-vc-v1-VcDictionaryError-product) | Продукт |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-VcDictionaryError-message"></a> [message](#keyapis-vc-v1-VcDictionaryError-message) | Сообщение |    [string](#scalar-types) | <nil>|
| <a id="keyapis-vc-v1-VcDictionaryError-reasons"></a> [reasons](#keyapis-vc-v1-VcDictionaryError-reasons) | Причины |  repeated  [keyapis.vc.v1.VcDictionaryError.Reason](#keyapis-vc-v1-VcDictionaryError-Reason) | <nil>|






<a name="keyapis-vc-v1-VcDictionaryError-Reason"></a>


### [VcDictionaryError.Reason](#keyapis-vc-v1-VcDictionaryError-Reason)
 Причина


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-VcDictionaryError-Reason-message"></a> [message](#keyapis-vc-v1-VcDictionaryError-Reason-message) | Сообщение |    [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 |