Notificações (notifications)

Notificações (notifications)

76 views 01/10/2020 12/12/2020 integrador 0

2.0info: 8.2.1 Notificações description: Serviço de notificações x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: notifications contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/notifications/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /actions/notifyUser: post: description: Envia uma notificação para um usuário, sem realizar validação se o usuário existe. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/notificationPayload responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicating operation success default: description: Error response schema: #/definitions/genericError /actions/notifyUser (v2): post: description: Envia uma notificação para um ou mais usuários, validando se os mesmos existem. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – in: header name: accept description: _MIME type_ e versão do endpoint utilizado na requisição. [SAIBA MAIS](https://dev.senior.com.br/documentacao/guia-de-api/versionamento/). type: string default: application/json;seniorx.version=2 – name: input in: body required: true schema: #/definitions/baseNotificationPayload responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Se passou pelas validações de envio da notificação default: description: Error response schema: #/definitions/genericErrordefinitions: userNotificationKind: type: string enum: – Operational – Management – News userNotificationPriority: type: string enum: – Error – Alert – None severity: type: string enum: – INFO – ERROR – WARNING – SUCCESS baseNotificationPayload: type: object required: – notificationOrigin – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService properties: notificationClass: type: string description: Class of notification. Identifies the context of the notification/group of notifications. ATTENTION: THIS FIELD WILL BECOME REQUIRED AS OF AUGUST 2019. notificationOrigin: type: string description: Origin of notification. Free text. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority notificationSubject: type: string description: Notification subject notificationContent: type: string description: Notification content sourceDomain: type: string description: Domain that generates the notification sourceService: type: string description: Service that generates the notification destinationUsers: type: array items: type: string description: Names of the destination users link: type: string description: Notification link. isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string description: Expiration date of the notification format: date-time severity: #/definitions/severity notificationPayload: type: object required: – notificationOrigin – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService properties: notificationClass: type: string description: Class of notification. Identifies the context of the notification/group of notifications. ATTENTION: THIS FIELD WILL BECOME REQUIRED AS OF AUGUST 2019. notificationOrigin: type: string description: Origin of notification. Free text. notificationKind: #/definitions/userNotificationKind notificationPriority: #/definitions/userNotificationPriority notificationSubject: type: string description: Notification subject notificationContent: type: string description: Notification content sourceDomain: type: string description: Domain that generates the notification sourceService: type: string description: Service that generates the notification destinationUsers: type: array items: type: string description: Names of the destination users link: type: string description: Notification link. isBanner: type: boolean description: Flag to indicate that the notification will be shown as a Banner expirationDate: type: string description: Expiration date of the notification format: date-time severity: #/definitions/severity destinationUser: type: string description: Name of the destination user genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment