Протокол¶
Оглавление¶
-
deviceapis/device/v1/deviceapis_device_room_v1.proto
- DeleteRoomListResponse
- DeleteRoomListResponse.Error
- DeleteRoomRequest
- DeleteRoomResponse
- DeleteRoomResponse.Error
- GetRoomCountRequest
- GetRoomCountResponse
- GetRoomListRequest
- GetRoomListResponse
- GetRoomRequest
- GetRoomResponse
- Room
- RoomFilter
- RoomPaging
- SaveRoomListRequest
- SaveRoomListResponse
- SaveRoomListResponse.Error
- SaveRoomRequest
- SaveRoomResponse
- SaveRoomResponse.Error
Схема классов¶
deviceapis/device/v1/deviceapis_device_room_v1.proto¶
Сервис управления настройками квартир
RoomService¶
Сервис управления настройками квартир
DeleteRoomListRequest¶
Запрос удаления списка настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр квартир. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ | deviceapis.device.v1.RoomFilter |
DeleteRoomListResponse¶
Ответ на запрос удаления списка настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество удаленных | optional int32 | |
| error | Ошибка | optional deviceapis.device.v1.DeleteRoomListResponse.Error |
DeleteRoomListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
DeleteRoomRequest¶
Запрос удаления настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| room_number | Номер квартиры | string | REQUIRED |
DeleteRoomResponse¶
Ответ на запрос удаления настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional deviceapis.device.v1.DeleteRoomResponse.Error |
DeleteRoomResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetRoomCountRequest¶
Запрос получения количества квартир
GetRoomCountResponse¶
Ответ на запрос получения количества квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего количество | optional int32 |
GetRoomListRequest¶
Запрос получения списка настроек квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| paging | Постраничный вывод | optional deviceapis.device.v1.RoomPaging |
GetRoomListResponse¶
Ответ на запрос получения списка настроек квартир
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список Room | repeated deviceapis.device.v1.Room |
GetRoomRequest¶
Запрос получения настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| room_number | Номер квартиры | string | REQUIRED |
GetRoomResponse¶
Ответ на запрос получения настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Квартира | optional deviceapis.device.v1.Room |
Room¶
Квартира
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| room_number | Номер квартиры | string | REQUIRED |
| sip_forwarding_number | Номер Sip-переадресации вызова. Диапазон: 5..200 | string | |
| analog_phone_cms_number | Номер координатно-матричной аналоговой трубки. Где пример значения K1E9D8 - это К1 = коммутатор 1; Е9 = единицы 9; Д8 = десятки 8. Паттерн: /^[A-Za-z]\d[A-Za-z]\d[A-Za-z]\d$/ | optional string | |
| analog_phone_digital_number | Номер цифровой трубки. Диапазон: 1..255 | optional int32 | |
| is_analog_phone_blocked | Признак блокировки аналоговой (CMS) или адресно-цифровой (digital headset) трубки | bool |
RoomFilter¶
Фильтр квартир. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| room_numbers | По номерам квартир. При пустом массиве удалятся все квартиры | repeated string |
RoomPaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
SaveRoomListRequest¶
Запрос сохранения списка настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список Room | repeated deviceapis.device.v1.Room |
SaveRoomListResponse¶
Ответ на запрос сохранения списка настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Список Room | repeated deviceapis.device.v1.Room | |
| errors | Список ошибок | repeated deviceapis.device.v1.SaveRoomListResponse.Error |
SaveRoomListResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| room_number | Номер квартиры | string | REQUIRED |
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
SaveRoomRequest¶
Запрос сохранения настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Квартира | deviceapis.device.v1.Room | REQUIRED |
SaveRoomResponse¶
Ответ на запрос сохранения настроек квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Квартира | optional deviceapis.device.v1.Room | |
| error | Ошибка | optional deviceapis.device.v1.SaveRoomResponse.Error |
SaveRoomResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
Скалярные типы значений¶
| .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 |