Протокол¶
Оглавление¶
Схема классов¶
keyapis/multiapp/v1/keyapis_multiapp_notification_v1.proto¶
Сервис реализует функционал управления уведомлениями
NotificationService¶
Сервис уведомлений
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| PostNotification | Метод отправки уведомления уведомления. Метод доступен для: partner. Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization | keyapis.multiapp.v1.PostNotificationRequest | keyapis.multiapp.v1.PostNotificationResponse |
Notification¶
Уведомление
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| app_id | Идентификатор приложения. # Тип: Guid | string | REQUIRED |
| orpon | ОРПОН. # Диапазон 1..9223372036854775807 | int64 | REQUIRED |
| room_numbers | Номер квартиры. # Диапазон: 1..150 | repeated string | REQUIRED |
| template_id | Идентификатор шаблона. # Тип: Guid | string | REQUIRED |
| values | Значения для подстановки в текст шаблона | repeated keyapis.multiapp.v1.Notification.ValuesEntry | REQUIRED |
| payload | Полезная нагрузка | repeated keyapis.multiapp.v1.Notification.PayloadEntry |
Notification.PayloadEntry¶
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| key | string | ||
| value | string |
Notification.ValuesEntry¶
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| key | string | ||
| value | string |
PostNotificationRequest¶
Запрос сохранения уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Уведомление | keyapis.multiapp.v1.Notification | REQUIRED |
PostNotificationResponse¶
Ответ на запрос сохранения уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| error | Ошибка | optional keyapis.multiapp.v1.PostNotificationResponse.Error |
PostNotificationResponse.Error¶
Ошибка запроса сохранения уведомления
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.multiapp.v1.ValidationError | |
| values | Значения для подстановки не соответствуют шаблону уведомления | optional keyapis.multiapp.v1.PostNotificationResponse.Error.ValuesError | |
| app_blocked | Приложение находится в статусе "Заблокировано" | optional keyapis.multiapp.v1.PostNotificationResponse.Error.AppBlockedError | |
| app_assignment | Ошибка связанная с назначениями приложения | optional keyapis.multiapp.v1.PostNotificationResponse.Error.AppAssignmentError |
PostNotificationResponse.Error.AppAssignmentError¶
Ошибка свзяанная с назначениями приложения. Причины: - Приложение назначено не только по ОРПОНу или ОРПОНу и номеру квартиры; - Приложение не назначено на переданные orpon и room_number
PostNotificationResponse.Error.AppBlockedError¶
Приложение находится в статусе "Заблокировано"
PostNotificationResponse.Error.ValuesError¶
Значения для подстановки не соответствуют шаблону уведомления
Скалярные типы значений¶
| .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 |