Swagger UI

Notification System

 1.0.0

[ Base URL: api.glowmarkt.com/api/v0-1/ns ]

This is the documentation of the Notification System. Add text explaining each object.

Find out more about Glowmarkt

Schemes

alerttypeThe definition of an alert, what functionality the alert represents. It is an identifier which amongst other elements will point us to the correct template. An alert type belongs to an application.

GET/alerttype

Find all alert types of an application

POST/alerttype

Create an alert type

GET/alerttype/{alertTypeId}

Find alert type by ID

PUT/alerttype/{alertTypeId}

Updates the alert type's metadata.

templateThe template of the message that is being sent; it can be passed through as HTML or JSON. Each template has an alert type, is specific to a single channel of communication and a culrture code.

GET/template

Find all templates of an application

POST/template

Create a template

GET/template/{templateId}

Find template type by ID

PUT/template/{templateId}

Updates the teplate's metadata.

GET/template/{alertTypeId}/{channelType}/{cultureCode}

Find template by alertTypeId, channeType and cultureCode

POST/template/{alertTypeId}/{channelType}/{cultureCode}

Create template by alertTypeId, channeType and cultureCode

alertAn application can send an alert to a customer across multiple channels (email, push, inbox) which will convey some type of specific message (defined by the alert type).

POST/alert

Send an alert

GET/alert/{alertId}

Get an alert by Id

GET/alert/user

Get the alerts sent to a user

notificationWhen an application triggeers an alert, for each channel of communication a notification is created. This enables the system to monitor seperately whant happens in each channel.

GET/notification/{notificationId}

Get a notification by Id

GET/notification/{notificationId}/log

Get the logs of a particular notification

Models

#/definitions/AlertTypeAlertType{...}

#/definitions/AlertReqAlertReq{...}

#/definitions/AlertResAlertRes{...}

#/definitions/AlertReqAlertReq{...}

#/definitions/AlertTypeReqAlertTypeReq{...}

#/definitions/AlertTypeUpdateAlertTypeUpdate{...}

#/definitions/NotificationLogNotificationLog{...}

#/definitions/NotificationNotification{...}

#/definitions/TemplateTemplate{...}

#/definitions/TemplateReqTemplateReq{...}

Error{...}

#/definitions/AccessDeniedErrorAccessDeniedError{...}

#/definitions/InternalServerErrorInternalServerError{...}

IncorrectElementsError{...}

#/definitions/MissingElementsErrorMissingElementsError{...}

ApiResponse{...}