Протокол¶
Оглавление¶
-
keyapis/subscription/v1/keyapis_subscription_service_v1.proto
- GetServiceKindListResponse
- GetServiceListRequest
- GetServiceListResponse
- GetServicePrivilegeCountRequest
- GetServicePrivilegeCountResponse
- GetServicePrivilegeListRequest
- GetServicePrivilegeListResponse
- Service
- ServiceKind
- ServicePrivilegeFilter
- ServicePrivilegePaging
- ServicePrivilegePaging.OrderByType
Схема классов¶
keyapis/subscription/v1/keyapis_subscription_service_v1.proto¶
Сервис реализует устаревший функционал управления услугами. Услуги это составные части привилегии на квартиру, сейчас считаются устаревшими, использовать нужно привилегии, сделаны тут для совместимости
ServiceService¶
Сервис услуг
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetServiceList | Метод получения услуг квартиры. Вернёт все услуги на квартире и недоступные по адресу как неактивные. Метод доступен для: admin, master, service, application(subscription:read или subscription:edit) | keyapis.subscription.v1.GetServiceListRequest | keyapis.subscription.v1.GetServiceListResponse stream |
| GetServicePrivilegeList | Метод получения списка услуг. Вернёт все услуги на квартире и недоступные по адресу как неактивные. Метод доступен для: admin, service | keyapis.subscription.v1.GetServicePrivilegeListRequest | keyapis.subscription.v1.GetServicePrivilegeListResponse stream |
| GetServicePrivilegeCount | Метод получения количества услуг. Вернёт все услуги на квартире и недоступные по адресу как неактивные. Метод доступен для: admin, service | keyapis.subscription.v1.GetServicePrivilegeCountRequest | keyapis.subscription.v1.GetServicePrivilegeCountResponse |
| GetServiceKindList | Метод получения справочника видов услуг. Метод доступен для: admin, service | keyapis.subscription.v1.GetServiceKindListRequest | keyapis.subscription.v1.GetServiceKindListResponse stream |
GetServiceKindListRequest¶
Запрос получения справочника видов услуг
GetServiceKindListResponse¶
Результат запроса получения справочника видов услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Элемент справочника услуг | optional keyapis.subscription.v1.ServiceKind |
GetServiceListRequest¶
Запрос получения списка услуг квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| orpon | ОРПОН. Идентификатор дома | int64 | REQUIRED |
| flat_number | Номер квартиры | string | REQUIRED |
GetServiceListResponse¶
Результат запроса получения списка услуг квартиры
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Услуга | optional keyapis.subscription.v1.Sevice |
GetServicePrivilegeCountRequest¶
Запрос получения количества услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.subscription.v1.ServicePrivilegeFilter | |
| paging | Стандартный постраничный вывод | optional keyapis.subscription.v1.ServicePrivilegePaging |
GetServicePrivilegeCountResponse¶
Результат запроса получения количества услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Количество | optional int32 |
GetServicePrivilegeListRequest¶
Запрос получения списка услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.subscription.v1.ServicePrivilegeFilter | |
| paging | Стандартный постраничный вывод | optional keyapis.subscription.v1.ServicePrivilegePaging |
GetServicePrivilegeListResponse¶
Результат запроса получения списка услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Услуга | optional keyapis.subscription.v1.Service |
Service¶
Услуга
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| name | Название услуги на английском | string | |
| is_active | Доступна ли услуга на квартире. Вернётся true если статусы привилегии: - PROMO; - PAID; - TURNS_OFF. Вернётся false если статусы привилегии: - NOT_PAID; - CAN_BE_PAID; - STATE_TYPE_UNKNOWN; - Не найден (нет на кваритре, но есть в справочнике привилегий) | bool | |
| orpon | ОРПОН дома | google.protobuf.Int64Value | |
| flat_number | Номер квартиры | google.protobuf.StringValue |
ServiceKind¶
Элемент справочника видов услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор услуги | int32 | |
| category | Категория услуги. Аналогично V1ServiceDto.type | string | |
| name | Название услуги на английском | string | |
| title | Название услуги | string | |
| description | Описание услуги | google.protobuf.StringValue | |
| parent_id | Идентификатор родительской услуги | google.protobuf.Int32Value |
ServicePrivilegeFilter¶
Фильтр услуг
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| orpons | По ОРПОН | repeated int64 | |
| flat_numbers | По номеру квартиры | repeated string |
ServicePrivilegePaging¶
Постраничный вывод
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: ORPON_THEN_FLAT_NUMBER | keyapis.subscription.v1.ServicePrivilegePaging.OrderByType | |
| direction_type | Тип направления сортировки. # По умолчанию: DESC | keyapis.subscription.v1.ServicePrivilegePaging.DirectionType | |
| limit | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | int32 | |
| offset | Сдвиг. # Диапазон: 0..2147483647 | int32 |
Sevice¶
Услуга. TODO: deprecated
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| name | Название услуги на английском | string | |
| is_active | Доступна ли услуга на квартире. Вернётся true если статусы привилегии: - PROMO; - PAID; - TURNS_OFF. Вернётся false если статусы привилегии: - NOT_PAID; - CAN_BE_PAID; - STATE_TYPE_UNKNOWN; - Не найден (нет на кваритре, но есть в справочнике привилегий) | bool |
ServicePrivilegePaging.DirectionType¶
Справочник типов направлений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
ServicePrivilegePaging.OrderByType¶
Справочник типов значений сортировки.
Тип: byte¶
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ORPON_THEN_FLAT_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 |