{"info":{"_postman_id":"fe70a1ee-fade-4e62-b41f-fe313ff8b492","name":"Notification Service","description":"

This service provides interface for sending notification through different mediums. Right now, only SMS, Email and push notification are supported, but more will be added later. The json schema used for sending notifcation is as follow:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
mediumThis Field is required. It is the choice of the medium through which the notification is going to be sent. At the moment this field accepts: sms , email , and push_notification.
payloadThis field is required. It is actually an embeded object containing everything needed to send the notification through that meidum including the messege it self and the receiver.
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25449104","collectionId":"fe70a1ee-fade-4e62-b41f-fe313ff8b492","publishedId":"2s9YeD7YKu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-11-24T10:53:21.000Z"},"item":[{"name":"email notification sending","id":"e0dbc929-7a0f-4eed-b3bb-030dd713d999","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"medium\": \"email\",\r\n \"payload\": {\r\n \"receiver\": \"email@example.com\",\r\n \"subject\": \"Example Subject\",\r\n \"messege\": \"This is an example messege\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/","description":"

This is a request for a notification sent through email. In response the taskId is the identiier, which allows the user to check the status of the notification later.

\n","urlObject":{"protocol":"http","port":"8080","path":[""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"5b66bcd3-e550-4d45-96c9-ea92532ed518","name":"email notification sending","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"medium\": \"email\",\r\n \"payload\": {\r\n \"receiver\": \"email@example.com\",\r\n \"subject\": \"Example Subject\",\r\n \"messege\": \"This is an example messege\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Nov 2023 06:51:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.13"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"50"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"taskId\": \"92757843-e4f7-4de7-8fa1-e11f5e759d46\"\n}"}],"_postman_id":"e0dbc929-7a0f-4eed-b3bb-030dd713d999"},{"name":"push notification sending","id":"cf0c8374-c6ff-4dc4-9ec4-2161d582b7b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"medium\": \"push_notification\",\r\n \"payload\": {\r\n \"receiver\": \"Example Receiver\",\r\n \"messege\": \"Example push notification\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/","description":"

This is another example, which uses the push_notification medium instead of email, and it has a slightly different payload structure than the previous request.

\n","urlObject":{"protocol":"http","port":"8080","path":[""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0949634d-64e6-45c9-8f95-5435acf4c152","name":"push notification sending","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"medium\": \"push_notification\",\r\n \"payload\": {\r\n \"receiver\": \"Example Receiver\",\r\n \"messege\": \"Example push notification\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Nov 2023 06:53:39 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.13"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"50"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"taskId\": \"bed87645-8ad5-41fb-926c-7ee2f2cbb30f\"\n}"}],"_postman_id":"cf0c8374-c6ff-4dc4-9ec4-2161d582b7b4"},{"name":"Notification Status Check","id":"4ee5729b-f2db-4afb-88b5-144dfec1383d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"taskId\": \"bed87645-8ad5-41fb-926c-7ee2f2cbb30f\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/","description":"

This is the request, which allows the user to check for the notification status.

\n","urlObject":{"protocol":"http","port":"8080","path":[""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"0f2d64cb-23b5-459c-b71b-6559860357d5","name":"Notification Status Check","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"taskId\": \"bed87645-8ad5-41fb-926c-7ee2f2cbb30f\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Nov 2023 06:54:57 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.10.13"},{"key":"Content-Type","value":"application/json"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"250"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"bed87645-8ad5-41fb-926c-7ee2f2cbb30f\",\n \"status\": \"SUCCESS\",\n \"result\": \"\\\"Via Push Notification : deliver Example push notification to Example Receiver\\\"\",\n \"traceback\": null,\n \"children\": [],\n \"date_done\": {\n \"$date\": \"2023-11-24T06:53:39.422Z\"\n }\n}"}],"_postman_id":"4ee5729b-f2db-4afb-88b5-144dfec1383d"}]}