Notification Service (2.2.0)

Download OpenAPI specification:Download

This is the spec that defines the API provided by the Notification Service.

Subscriber

getSubscribers

Get all the subscribers from the notification service.

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

get/subscribers
http://gonotification-service:8088/v1/notification/subscribers

getSubscriber

Get the subscriber from the notification service given subscriber ID.

path Parameters
id
required
integer

ID of the subscriber entry

Responses

200

OK

401

Authorization information is missing or invalid.

404

A subscriber with the given subscriber ID was not found.

500

Unexpected error.

default

Unexpected error.

get/subscribers/{id}
http://gonotification-service:8088/v1/notification/subscribers/{id}

deleteSubscriber

Delete the specified subscriber from the notification service.

path Parameters
id
required
integer

ID of the subscriber entry to be deleted.

Responses

200

OK

401

Authorization information is missing or invalid.

404

A subscriber with the given subscriber ID was not found.

500

Unexpected error.

default

Unexpected error.

delete/subscribers/{id}
http://gonotification-service:8088/v1/notification/subscribers/{id}

Register

registerSubscriber

Register subscriber with the notification service.

Request Body schema: application/json

Register a new subscriber for notification messages.

handler
required
string
endpoint
required
string
config
required
object

Responses

200

OK

401

Authorization information is missing or invalid.

500

Unexpected error.

default

Unexpected error.

post/subscribers
http://gonotification-service:8088/v1/notification/subscribers

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "handler": "string",
  • "endpoint": "string",
  • "config": { }
}