Forum APIs

Get Forum Id

This api allow the user to get the forum id

• The endpoint for Forum is /forum/v2/read
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v2/read

POSThttps://staging.sunbirded.org/api/discussion/forum/v2/read

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

typestring

identifierstring

cidinteger

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v2/read', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "type": "course",
        "identifier": "do_12345678996312"
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "identifier": "identifier",
    "type": "type",
    "cid": 0
  }
]

Attaching category for context

This api allow the user to attaching category id with a context

• The endpoint for Forum is /forum/v3/create
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v3/create

POSThttps://staging.sunbirded.org/api/discussion/forum/v3/create

Header parameters

Body

application/json

categoryobject

Response

200

successful operation

Body

application/json

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v3/create', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "category": {
        "name": "Batch 1",
        "pid": 567,
        "description": "<p>Mentors can start discussions</p>",
        "privileges": {
          "copyFromCategory": 268
        },
        "context": [
          {
            "type": "batch",
            "identifier": "01307806402750054416"
          }
        ],
        "subcategories": [
          {
            "name": "Annoucements",
            "description": "<p>Only creators can make annoucements</p>",
            "privileges": {
              "copyFromParent": true
            },
            "__$markdownParsed": true
          }
        ],
        "__$markdownParsed": true
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "forums": [
      {
        "sbType": "batch",
        "sbIdentifier": "01307806402750054416",
        "newCid": 580,
        "cids": [
          580
        ]
      }
    ],
    "groups": [
      {
        "name": "registered-users",
        "members": [
          {
            "uid": 29,
            "userName": "content_reviewer_tn1970",
            "sbUid": "08631a74-4b94-4cf7-a818-831135248a4a"
          }
        ]
      }
    ],
    "subcategories": [
      {
        "name": "Annoucements",
        "cid": 581,
        "pid": 580,
        "groups": [
          {
            "name": "registered-users",
            "members": [
              {
                "uid": 29,
                "userName": "content_reviewer_tn1970",
                "sbUid": "08631a74-4b94-4cf7-a818-831135248a4a"
              }
            ]
          }
        ]
      }
    ]
  }
]

Remove forum id

This api allow the user to remove forum id

• The endpoint for Forum is /forum/v2/remove
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v2/remove

POSThttps://staging.sunbirded.org/api/discussion/forum/v2/remove

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

idstring

verstring

etsnumber

paramsobject

responseCodestring

resultstring

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v2/remove', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sbType": "course",
      "cid": [
        2
      ],
      "sbIdentifier": "do_123456789"
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "api.forum.v2.remove",
    "ver": "1.0",
    "ets": 1618421469097,
    "params": {
      "resmsgid": "01d3023f-e68f-4e5a-84dc-e67aa69dfd48",
      "msgid": "",
      "status": "Success"
    },
    "responseCode": "OK",
    "result": "Forum remove for context success"
  }
]

Get nodebb uids based on sunbird id

This api allow the user to get nodebb id bypassing sunbird id

• The endpoint for Forum is /forum/v2/uids
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v2/uids

POSThttps://staging.sunbirded.org/api/discussion/forum/v2/uids

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v2/uids', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "sbIdentifiers": [
          "08631a74-4b94-4cf7-a818-831135248a4a"
        ]
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": ".api.forum.v2.uids",
    "ver": "1.0",
    "ets": 1618428120524,
    "params": {
      "resmsgid": "3bf46d2d-6dd4-49e5-a2e7-6b7fa16101b3",
      "msgid": "",
      "status": "Success"
    },
    "responseCode": "OK",
    "result": {
      "userIds": [
        {
          "nodebbUid": 29,
          "sbUid": "08631a74-4b94-4cf7-a818-831135248a4a"
        }
      ]
    }
  }
]

Get nodebb users added for a category

This api allow the user to get nodebb users added for a category

• The endpoint for Forum is /forum/v3/groups/users
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v3/groups/users

POSThttps://staging.sunbirded.org/api/discussion/forum/v3/groups/users

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

resultobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v3/groups/users', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "cid": 268
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "result": {
      "groups": [
        {
          "name": "text",
          "members": [
            {
              "uid": 0,
              "userName": "text",
              "sbUid": "text"
            }
          ]
        }
      ]
    }
  }
]

Add sunbird users into nodebb group

This api allow the user to add sunbird users into nodebb group

• The endpoint for Forum is /forum/v3/groups/membership
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v3/groups/membership

POSThttps://staging.sunbirded.org/api/discussion/forum/v3/group/membership

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

groupsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v3/group/membership', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "groups": [
          "Category Owner"
        ],
        "members": [
          {
            "sbUserName": "content_reviewer_tn1970",
            "sbUid": "08631a74-4b94-4cf7-a818-831135248a4a"
          }
        ]
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "groups": [
      {
        "name": "text",
        "members": [
          {
            "uid": 0,
            "userName": "text",
            "sbUid": "text"
          }
        ]
      }
    ]
  }
]

Get context based tags

This api allow the user to get context based tags

• The endpoint for Forum is /forum/tags
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/tags

POSThttps://staging.sunbirded.org/api/discussion/forum/tags

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

valuestring

valueEscapedstring

colorstring

bgColorstring

scorenumber

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/tags', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "cids": [
          2,
          3
        ]
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "value": "text",
    "valueEscaped": "text",
    "color": "text",
    "bgColor": "text",
    "score": 0
  }
]

Get nodebb privileges added for a category

This api allow the user to get nodebb privileges added for a category

• The endpoint for Forum is /forum/v3/category/{cid}/privileges
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/forum/v3/category/{cid}/privileges

POSThttps://staging.sunbirded.org/api/discussion/forum/v3/category/{cid}/privileges

Path parameters

cid*integer

Header parameters

Body

application/json

requestobject

Response

200

successful operation

Body

application/json

groupsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/forum/v3/category/{cid}/privileges', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "groups": [
          "Category Owner",
          "registered-users"
        ]
      }
    }),
});
const data = await response.json();

Response

200

[
  {
    "groups": [
      {
        "name": "text",
        "nameEscaped": "text",
        "isPrivate": false,
        "isSystem": false
      }
    ]
  }
]

Get list of all tags

This api is used to fetch tags from nodebb.

• The endpoint for Tags is /tags
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/tags

GEThttps://staging.sunbirded.org/api/discussion/tags

Header parameters

Response

200400

successful operation

Body

application/json

valuestring

scoreinteger

valueEscapedstring

colorstring

bgColorstring

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/tags', {
    method: 'GET',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200400

[
  {
    "value": "learning",
    "score": 1,
    "valueEscaped": "learning",
    "color": "#FFF",
    "bgColor": "#EEE"
  }
]

Get List of category details for based on tag name and cid.

This api allow the user to get all the details of category based on tag name and cid mentioned in array from nodebb

• The endpoint for Tag is /tags/list
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/tags/list

POSThttps://staging.sunbirded.org/api/discussion/tags/list

Header parameters

Body

application/json

requestobject

Response

200400

successful operation

Body

application/json

bgColorstring

cidinteger

classstring

colorstring

descriptionstring

descriptionParsedstring

disabledinteger

iconstring

imageClassstring

isSectioninteger

linkstring

namestring

numRecentRepliesinteger

orderinteger

parentCidinteger

post_countinteger

slugstring

topic_countinteger

minTagsinteger

maxTagsinteger

totalPostCountinteger

totalTopicCountinteger

tagWhitelistarray of string

unread-classstring

childrenarray of object

topicsarray of discussionForumCategoryDetails_topics (object)

isWatchedboolean

isNotWatchedboolean

isIgnoredboolean

breadcrumbsarray of object

titlestring

privilegesobject

showSelectboolean

showTopicToolsboolean

rssFeedUrlstring

feeds:disableRSSinteger

reputation:disabledinteger

paginationobject

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

_headerobject

widgetsobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/tags/list', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "tag": "nodebb",
        "cid": [
          2,
          3
        ]
      }
    }),
});
const data = await response.json();

Response

200400

[
  {
    "unread-class": "unread-class",
    "template": {},
    "privileges": {},
    "pagination": {},
    "color": "color",
    "numRecentReplies": 5,
    "icon": "icon",
    "link": "link",
    "_header": {},
    "description": "<p>description</p>",
    "title": "title",
    "widgets": {},
    "showSelect": true,
    "totalTopicCount": 7,
    "parentCid": 2,
    "maxTags": 2,
    "totalPostCount": 4,
    "bgColor": "bgColor",
    "descriptionParsed": "descriptionParsed",
    "children": [
      {},
      {}
    ],
    "bodyClass": "bodyClass",
    "disabled": 6,
    "rssFeedUrl": "rssFeedUrl",
    "tagWhitelist": [
      "tagWhitelist",
      "tagWhitelist"
    ],
    "class": "class",
    "slug": "slug",
    "order": 5,
    "minTags": 3,
    "showTopicTools": true,
    "topics": [
      {
        "pinned": 6,
        "lastposttime": 1,
        "upvotes": 8,
        "unreplied": true,
        "unread": true,
        "timestampISO": "timestampISO",
        "title": "title",
        "teaserPid": {},
        "tid": 7,
        "uid": 4,
        "lastposttimeISO": "lastposttimeISO",
        "deleterUid": 6,
        "isOwner": true,
        "mainPid": 1,
        "locked": 9,
        "slug": "slug",
        "timestamp": 1,
        "ignored": true,
        "index": 6,
        "downvotes": 9,
        "icons": {},
        "tags": {},
        "bookmark": {},
        "deleted": 9,
        "postcount": 6,
        "viewcount": 5,
        "titleRaw": "titleRaw",
        "votes": 3,
        "category": {},
        "user": {},
        "cid": 1,
        "teaser": {}
      },
      {
        "pinned": 6,
        "lastposttime": 1,
        "upvotes": 8,
        "unreplied": true,
        "unread": true,
        "timestampISO": "timestampISO",
        "title": "title",
        "teaserPid": {},
        "tid": 7,
        "uid": 4,
        "lastposttimeISO": "lastposttimeISO",
        "deleterUid": 6,
        "isOwner": true,
        "mainPid": 1,
        "locked": 9,
        "slug": "slug",
        "timestamp": 1,
        "ignored": true,
        "index": 6,
        "downvotes": 9,
        "icons": {},
        "tags": {},
        "bookmark": {},
        "deleted": 9,
        "postcount": 6,
        "viewcount": 5,
        "titleRaw": "titleRaw",
        "votes": 3,
        "category": {},
        "user": {},
        "cid": 1,
        "teaser": {}
      }
    ],
    "isNotWatched": true,
    "reputation:disabled": 2,
    "isWatched": true,
    "isIgnored": true,
    "topic_count": 9,
    "url": "url",
    "imageClass": "imageClass",
    "feeds:disableRSS": 1,
    "loggedIn": true,
    "name": "name",
    "isSection": 1,
    "post_count": 7,
    "relative_path": "relative_path",
    "breadcrumbs": [
      {},
      {}
    ],
    "cid": 0,
    "__$markdownParsed": true
  }
]

Copy privileges from one category to another category

This api allow the user to copy all privileges from one category to another category.

• The endpoint for Privileges is /privileges/v2/copy
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/privileges/v2/copy

POSThttps://staging.sunbirded.org/api/discussion/privileges/v2/copy

Header parameters

Body

application/json

resultobject

Response

200400

successful operation

Body

application/json

idstring

verstring

etsnumber

paramsobject

responseCodestring

resultstring

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/privileges/v2/copy', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "pid": 2,
        "cid": 3
      }
    }),
});
const data = await response.json();

Response

200400

{
  "id": "api.forum.v2.remove",
  "ver": "1.0",
  "ets": 1618421469097,
  "params": {
    "resmsgid": "01d3023f-e68f-4e5a-84dc-e67aa69dfd48",
    "msgid": "",
    "status": "Success"
  },
  "responseCode": "OK",
  "result": "Privileges copied successfuly"
}