Протокол¶
Оглавление¶
-
deviceapis/device/v1/deviceapis_device_rfid_v1.proto
- DeleteRfidListResponse
- DeleteRfidRequest
- DeleteRfidResponse
- DeleteRfidResponse.Error
- GetRfidCountRequest
- GetRfidCountResponse
- GetRfidListRequest
- GetRfidListResponse
- GetRfidRequest
- GetRfidResponse
- Rfid
- Rfid.SavingError
- Rfid.SavingError.RelayNotFound
- RfidFilter
- RfidPaging
- SaveRfidListRequest
- SaveRfidListResponse
- SaveRfidListResponse.Error
- SaveRfidRequest
- SaveRfidResponse
- SaveRfidResponse.Error
Схема классов¶
deviceapis/device/v1/deviceapis_device_rfid_v1.proto¶
Сервис RFID ключей устройства
RfidService¶
Сервис RFID ключей устройства
DeleteRfidListRequest¶
Запрос удаления списка сущностей Rfid по фильтру
DeleteRfidListResponse¶
Ответ на запрос удаления списка сущностей Rfid по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество удаленных | optional int32 |
DeleteRfidRequest¶
Запрос удаления единичной сущности Rfid по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор UID [hex 14] | string | REQUIRED |
DeleteRfidResponse¶
Ответ на запрос удаления единичной сущности Rfid по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional deviceapis.device.v1.DeleteRfidResponse.Error |
DeleteRfidResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetRfidCountRequest¶
Запрос получения количества сущностей Rfid по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр ключей RFID. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ | deviceapis.device.v1.RfidFilter |
GetRfidCountResponse¶
Ответ на запрос получения количества сущностей Rfid по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество | optional int32 |
GetRfidListRequest¶
Запрос получения списка сущностей Rfid по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| paging | Постраничный вывод | optional deviceapis.device.v1.RfidPaging | |
| filter | Фильтр ключей RFID. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ | deviceapis.device.v1.RfidFilter |
GetRfidListResponse¶
Ответ на запрос получения списка сущностей Rfid по фильтру
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список Rfid | repeated deviceapis.device.v1.Rfid |
GetRfidRequest¶
Запрос получения единичной сущности Rfid по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор UID [hex 14] | string | REQUIRED |
GetRfidResponse¶
Ответ на запрос получения единичной сущности Rfid по ключу
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Ключ | optional deviceapis.device.v1.Rfid |
Rfid¶
Ключ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор UID [hex 14] | string | REQUIRED |
| description | Описание | google.protobuf.StringValue | |
| secret | Секрет [hex 14] | google.protobuf.StringValue | |
| relay_indexes | Идентификаторы реле. Диапазон: 1..64 | repeated int32 |
Rfid.SavingError¶
Ошибка запроса создания ключа
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| relay_not_found | Реле не найдено | optional deviceapis.device.v1.Rfid.SavingError.RelayNotFound |
Rfid.SavingError.RelayNotFound¶
Реле не найдено
RfidFilter¶
Фильтр ключей RFID. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| relay_indexes | По идентификаторам реле. Диапазон: 1..64 | repeated int32 |
RfidPaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
SaveRfidListRequest¶
Запрос на редактирование списка сущностей Rfid
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список Rfid | repeated deviceapis.device.v1.Rfid |
SaveRfidListResponse¶
Ответ на запрос на редактирование списка сущностей Rfid
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список Rfid | repeated deviceapis.device.v1.Rfid | |
| errors | Список ошибок | repeated deviceapis.device.v1.SaveRfidListResponse.Error |
SaveRfidListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор UID [hex 14] | string | REQUIRED |
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError | |
| saving | Ошибка сохранения | optional deviceapis.device.v1.Rfid.SavingError |
SaveRfidRequest¶
Запрос на создания/редактирование сущности Rfid
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Ключ | deviceapis.device.v1.Rfid | REQUIRED |
SaveRfidResponse¶
Ответ на запрос на создания/редактирование сущности Rfid
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Ключ | optional deviceapis.device.v1.Rfid | |
| error | Ошибка | optional deviceapis.device.v1.SaveRfidResponse.Error |
SaveRfidResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError | |
| saving | Ошибка сохранения | optional deviceapis.device.v1.Rfid.SavingError |
Скалярные типы значений¶
| .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 |