# Протокол

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

- [keyapis/multiapp/v1/keyapis_multiapp_notification_v1.proto](#keyapis_multiapp_v1_keyapis_multiapp_notification_v1-proto)
    - [NotificationService](#keyapis-multiapp-v1-NotificationService)
  
    - [Notification](#keyapis-multiapp-v1-Notification)
    - [Notification.PayloadEntry](#keyapis-multiapp-v1-Notification-PayloadEntry)
    - [Notification.ValuesEntry](#keyapis-multiapp-v1-Notification-ValuesEntry)
    - [PostNotificationRequest](#keyapis-multiapp-v1-PostNotificationRequest)
    - [PostNotificationResponse](#keyapis-multiapp-v1-PostNotificationResponse)
    - [PostNotificationResponse.Error](#keyapis-multiapp-v1-PostNotificationResponse-Error)
    - [PostNotificationResponse.Error.AppAssignmentError](#keyapis-multiapp-v1-PostNotificationResponse-Error-AppAssignmentError)
    - [PostNotificationResponse.Error.AppBlockedError](#keyapis-multiapp-v1-PostNotificationResponse-Error-AppBlockedError)
    - [PostNotificationResponse.Error.ValuesError](#keyapis-multiapp-v1-PostNotificationResponse-Error-ValuesError)
  


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




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

## [keyapis/multiapp/v1/keyapis_multiapp_notification_v1.proto](/protos/key/keyapis/multiapp/v1/keyapis_multiapp_notification_v1.proto)
Сервис реализует функционал управления уведомлениями


<a name="keyapis-multiapp-v1-NotificationService"></a>

### NotificationService
 Сервис уведомлений

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-multiapp-v1-PostNotification"></a> [PostNotification](#keyapis-multiapp-v1-PostNotification) | Метод отправки уведомления уведомления. Метод доступен для: partner. Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization | [keyapis.multiapp.v1.PostNotificationRequest](#keyapis-multiapp-v1-PostNotificationRequest) | [keyapis.multiapp.v1.PostNotificationResponse](#keyapis-multiapp-v1-PostNotificationResponse) |

 <!-- end services -->


<a name="keyapis-multiapp-v1-Notification"></a>


### [Notification](#keyapis-multiapp-v1-Notification)
 Уведомление


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-Notification-app_id"></a> [app_id](#keyapis-multiapp-v1-Notification-app_id) | Идентификатор приложения. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-Notification-orpon"></a> [orpon](#keyapis-multiapp-v1-Notification-orpon) | ОРПОН. # Диапазон 1..9223372036854775807 |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-Notification-room_numbers"></a> [room_numbers](#keyapis-multiapp-v1-Notification-room_numbers) | Номер квартиры. # Диапазон: 1..150 |  repeated  [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-Notification-template_id"></a> [template_id](#keyapis-multiapp-v1-Notification-template_id) | Идентификатор шаблона. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-Notification-values"></a> [values](#keyapis-multiapp-v1-Notification-values) | Значения для подстановки в текст шаблона |  repeated  [keyapis.multiapp.v1.Notification.ValuesEntry](#keyapis-multiapp-v1-Notification-ValuesEntry) | REQUIRED|
| <a id="keyapis-multiapp-v1-Notification-payload"></a> [payload](#keyapis-multiapp-v1-Notification-payload) | Полезная нагрузка |  repeated  [keyapis.multiapp.v1.Notification.PayloadEntry](#keyapis-multiapp-v1-Notification-PayloadEntry) | <nil>|






<a name="keyapis-multiapp-v1-Notification-PayloadEntry"></a>


### [Notification.PayloadEntry](#keyapis-multiapp-v1-Notification-PayloadEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-Notification-PayloadEntry-key"></a> [key](#keyapis-multiapp-v1-Notification-PayloadEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-multiapp-v1-Notification-PayloadEntry-value"></a> [value](#keyapis-multiapp-v1-Notification-PayloadEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-multiapp-v1-Notification-ValuesEntry"></a>


### [Notification.ValuesEntry](#keyapis-multiapp-v1-Notification-ValuesEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-Notification-ValuesEntry-key"></a> [key](#keyapis-multiapp-v1-Notification-ValuesEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-multiapp-v1-Notification-ValuesEntry-value"></a> [value](#keyapis-multiapp-v1-Notification-ValuesEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-multiapp-v1-PostNotificationRequest"></a>


### [PostNotificationRequest](#keyapis-multiapp-v1-PostNotificationRequest)
 Запрос сохранения уведомления


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-PostNotificationRequest-data"></a> [data](#keyapis-multiapp-v1-PostNotificationRequest-data) | Уведомление |    [keyapis.multiapp.v1.Notification](#keyapis-multiapp-v1-Notification) | REQUIRED|






<a name="keyapis-multiapp-v1-PostNotificationResponse"></a>


### [PostNotificationResponse](#keyapis-multiapp-v1-PostNotificationResponse)
 Ответ на запрос сохранения уведомления


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






<a name="keyapis-multiapp-v1-PostNotificationResponse-Error"></a>


### [PostNotificationResponse.Error](#keyapis-multiapp-v1-PostNotificationResponse-Error)
 Ошибка запроса сохранения уведомления


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-PostNotificationResponse-Error-validation"></a> [validation](#keyapis-multiapp-v1-PostNotificationResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.multiapp.v1.ValidationError](#keyapis-multiapp-v1-ValidationError) | <nil>|
| <a id="keyapis-multiapp-v1-PostNotificationResponse-Error-values"></a> [values](#keyapis-multiapp-v1-PostNotificationResponse-Error-values) | Значения для подстановки не соответствуют шаблону уведомления |  optional  [keyapis.multiapp.v1.PostNotificationResponse.Error.ValuesError](#keyapis-multiapp-v1-PostNotificationResponse-Error-ValuesError) | <nil>|
| <a id="keyapis-multiapp-v1-PostNotificationResponse-Error-app_blocked"></a> [app_blocked](#keyapis-multiapp-v1-PostNotificationResponse-Error-app_blocked) | Приложение находится в статусе "Заблокировано" |  optional  [keyapis.multiapp.v1.PostNotificationResponse.Error.AppBlockedError](#keyapis-multiapp-v1-PostNotificationResponse-Error-AppBlockedError) | <nil>|
| <a id="keyapis-multiapp-v1-PostNotificationResponse-Error-app_assignment"></a> [app_assignment](#keyapis-multiapp-v1-PostNotificationResponse-Error-app_assignment) | Ошибка связанная с назначениями приложения |  optional  [keyapis.multiapp.v1.PostNotificationResponse.Error.AppAssignmentError](#keyapis-multiapp-v1-PostNotificationResponse-Error-AppAssignmentError) | <nil>|






<a name="keyapis-multiapp-v1-PostNotificationResponse-Error-AppAssignmentError"></a>


### [PostNotificationResponse.Error.AppAssignmentError](#keyapis-multiapp-v1-PostNotificationResponse-Error-AppAssignmentError)
 Ошибка свзяанная с назначениями приложения.
Причины:
- Приложение назначено не только по ОРПОНу или ОРПОНу и номеру квартиры;
- Приложение не назначено на переданные orpon и room_number






<a name="keyapis-multiapp-v1-PostNotificationResponse-Error-AppBlockedError"></a>


### [PostNotificationResponse.Error.AppBlockedError](#keyapis-multiapp-v1-PostNotificationResponse-Error-AppBlockedError)
 Приложение находится в статусе "Заблокировано"






<a name="keyapis-multiapp-v1-PostNotificationResponse-Error-ValuesError"></a>


### [PostNotificationResponse.Error.ValuesError](#keyapis-multiapp-v1-PostNotificationResponse-Error-ValuesError)
 Значения для подстановки не соответствуют шаблону уведомления





 <!-- 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 |