APIs

API Documentation:

Detailed API information present in this Reference - API Document

Example:

Group Notification will use the new notification create API to create notifications as defined in the document Notification Design Discussion.

Read User Notification Feed

This API is used for getting in-App notification of the user, userId is uniquely identifies the user

• The endpoint for Get In-App user Feed from userId is /notification/v1/read/{userId}
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

GEThttps://staging.sunbirded.org/api/notification/v1/feed/read/{userId}

Path parameters

userId*string

Please append a valid user Id To the Request URL

Header parameters

Response

200401500

Success Read User Notification Feed

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/feed/read/{userId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Update Notification Feed Status

PATCHhttps://staging.sunbirded.org/api/notification/v1/feed/update

Header parameters

Body

application/json

request*object

Response

200400401500

Success Notification Status Update

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/feed/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": [
        {
          "ids": [
            "64ef2ccd-2ec7-4759-b500-590d4a6eccf3"
          ],
          "userId": "1234"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Delete Notification Feed

PATCHhttps://staging.sunbirded.org/api/notification/v1/feed/delete

Header parameters

Body

application/json

request*object

Response

200400401500

Success Notification Status Delete

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/feed/delete', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": [
        {
          "ids": [
            "64ef2ccd-2ec7-4759-b500-590d4a6eccf3"
          ],
          "userId": "1234",
          "category": "groups"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Create Notification Template

POSThttps://staging.sunbirded.org/api/notification/v1/template/create

Header parameters

Body

application/json

request*object

Response

200400401500

Success Notification template creation

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/template/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "ver": "4.4.0",
        "data": "{\"title\": \"${param1} has left the ${param2}\"}",
        "templateId": "user-exit-2-2",
        "type": "JSON",
        "config": {
          "test": "13231231"
        },
        "template_schema": "{\"$schema\":\"#/definition/params\",\"title\":\"params context\",\"description\":\"properties Data\",\"type\":\"object\",\"properties\":{\"param1\":{\"description\":\"property 1 value\",\"type\":\"string\"},\"param2\":{\"description\":\"property 2 value\",\"type\":\"string\"}},\"required\":[\"param1\",\"param2\"]}"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Update Notification Template

PATCHhttps://staging.sunbirded.org/api/notification/v1/template/update

Header parameters

Body

application/json

request*object

Response

200400401500

Success Notification template updated

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/template/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "templateId": "user-exit-2-2",
        "ver": "4.4.0",
        "data": "{\"title\": \"${param1} has left the ${param2}\"}"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Delete Notification Template

PATCHhttps://staging.sunbirded.org/api/notification/v1/template/delete

Header parameters

Body

application/json

request*object

Response

200400401500

Success Notification template deleted

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/template/delete', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "templateId": "user-exit-2-2"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

List all available Notification templates

This API is used for getting all available templates in the notification service

GEThttps://staging.sunbirded.org/api/notification/v1/template/list

Header parameters

Response

200401500

Success list all notification templates

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/template/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Map or Update Action Notification Template

PATCHhttps://staging.sunbirded.org/api/notification/v1/template/action/update

Header parameters

Body

application/json

request*object

Response

200400401500

Success Notification action template updated

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/template/action/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "templateId": "user-exit-2-2",
        "action": "member-add",
        "type": "Feed"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Get mapped notification template to the action

This API is used for getting available action mapped to templates in the notification service

GEThttps://staging.sunbirded.org/api/notification/v1/template/{action}

Path parameters

action*string

Please append a valid action To the Request URL

Header parameters

Response

200400401500

Success templates mappend to action

Body

application/json

idstring

verstring

tsstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/notification/v1/template/{action}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "v2.notification.send",
  "ver": "v1",
  "ts": "1628696821794",
  "params": {},
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

---

---