Topic APIs

Get unread topics

This api allow the user to get all the unread topics in nodebb

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

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

Header parameters

Response

200400

successful operation

Body

application/json

nextStartinteger

topicCountinteger

topicsarray of discussionForumTopicResponse_topics (object)

tidsarray of string

canPostboolean

showSelectboolean

showTopicToolsboolean

categoriesarray of discussionForumTopicResponse_categories (object)

allCategoriesUrlstring

selectedCategoryobject

selectedCidsarray of string

feeds:disableRSSinteger

rssFeedUrlstring

titlestring

filtersarray of object

selectedFilterobject

termsarray of object

selectedTermobject

paginationobject

breadcrumbsarray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

_headerobject

widgetsobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "template": {},
  "pagination": {},
  "_header": {},
  "nextStart": 0,
  "selectedTerm": {},
  "title": "title",
  "widgets": {},
  "showSelect": true,
  "canPost": true,
  "selectedCids": [
    "selectedCids",
    "selectedCids"
  ],
  "terms": [
    {},
    {}
  ],
  "bodyClass": "bodyClass",
  "topicCount": 6,
  "rssFeedUrl": "rssFeedUrl",
  "categories": [
    {
      "parentCid": 5,
      "color": "color",
      "bgColor": "bgColor",
      "level": "level",
      "name": "name",
      "icon": "icon",
      "selected": true,
      "cid": 4,
      "imageClass": "imageClass"
    },
    {
      "parentCid": 5,
      "color": "color",
      "bgColor": "bgColor",
      "level": "level",
      "name": "name",
      "icon": "icon",
      "selected": true,
      "cid": 4,
      "imageClass": "imageClass"
    }
  ],
  "showTopicTools": true,
  "topics": [
    {
      "pinned": 1,
      "lastposttime": 5,
      "upvotes": 1,
      "unreplied": true,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 7,
      "uid": 3,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 6,
      "isOwner": true,
      "mainPid": 5,
      "locked": 7,
      "slug": "slug",
      "timestamp": 9,
      "ignored": true,
      "index": 1,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 4,
      "postcount": 2,
      "viewcount": 2,
      "titleRaw": "titleRaw",
      "votes": 7,
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "backgroundImage": {},
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass"
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "picture": {},
        "username": "username",
        "status": "status"
      },
      "cid": 1,
      "teaser": {}
    },
    {
      "pinned": 1,
      "lastposttime": 5,
      "upvotes": 1,
      "unreplied": true,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 7,
      "uid": 3,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 6,
      "isOwner": true,
      "mainPid": 5,
      "locked": 7,
      "slug": "slug",
      "timestamp": 9,
      "ignored": true,
      "index": 1,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 4,
      "postcount": 2,
      "viewcount": 2,
      "titleRaw": "titleRaw",
      "votes": 7,
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "backgroundImage": {},
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass"
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "picture": {},
        "username": "username",
        "status": "status"
      },
      "cid": 1,
      "teaser": {}
    }
  ],
  "filters": [
    {},
    {}
  ],
  "allCategoriesUrl": "allCategoriesUrl",
  "url": "url",
  "selectedFilter": {},
  "tids": [
    "tids",
    "tids"
  ],
  "feeds:disableRSS": 9,
  "loggedIn": true,
  "selectedCategory": {},
  "relative_path": "relative_path",
  "breadcrumbs": [
    {},
    {}
  ]
}

Get recent topics

This api allow the user to get all the recent topics in nodebb

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

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

Header parameters

Response

200400

successful operation

Body

application/json

nextStartinteger

topicCountinteger

topicsarray of discussionForumTopicResponse_topics (object)

tidsarray of string

canPostboolean

showSelectboolean

showTopicToolsboolean

categoriesarray of discussionForumTopicResponse_categories (object)

allCategoriesUrlstring

selectedCategoryobject

selectedCidsarray of string

feeds:disableRSSinteger

rssFeedUrlstring

titlestring

filtersarray of object

selectedFilterobject

termsarray of object

selectedTermobject

paginationobject

breadcrumbsarray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

_headerobject

widgetsobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "template": {},
  "pagination": {},
  "_header": {},
  "nextStart": 0,
  "selectedTerm": {},
  "title": "title",
  "widgets": {},
  "showSelect": true,
  "canPost": true,
  "selectedCids": [
    "selectedCids",
    "selectedCids"
  ],
  "terms": [
    {},
    {}
  ],
  "bodyClass": "bodyClass",
  "topicCount": 6,
  "rssFeedUrl": "rssFeedUrl",
  "categories": [
    {
      "parentCid": 5,
      "color": "color",
      "bgColor": "bgColor",
      "level": "level",
      "name": "name",
      "icon": "icon",
      "selected": true,
      "cid": 4,
      "imageClass": "imageClass"
    },
    {
      "parentCid": 5,
      "color": "color",
      "bgColor": "bgColor",
      "level": "level",
      "name": "name",
      "icon": "icon",
      "selected": true,
      "cid": 4,
      "imageClass": "imageClass"
    }
  ],
  "showTopicTools": true,
  "topics": [
    {
      "pinned": 1,
      "lastposttime": 5,
      "upvotes": 1,
      "unreplied": true,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 7,
      "uid": 3,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 6,
      "isOwner": true,
      "mainPid": 5,
      "locked": 7,
      "slug": "slug",
      "timestamp": 9,
      "ignored": true,
      "index": 1,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 4,
      "postcount": 2,
      "viewcount": 2,
      "titleRaw": "titleRaw",
      "votes": 7,
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "backgroundImage": {},
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass"
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "picture": {},
        "username": "username",
        "status": "status"
      },
      "cid": 1,
      "teaser": {}
    },
    {
      "pinned": 1,
      "lastposttime": 5,
      "upvotes": 1,
      "unreplied": true,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 7,
      "uid": 3,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 6,
      "isOwner": true,
      "mainPid": 5,
      "locked": 7,
      "slug": "slug",
      "timestamp": 9,
      "ignored": true,
      "index": 1,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 4,
      "postcount": 2,
      "viewcount": 2,
      "titleRaw": "titleRaw",
      "votes": 7,
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "backgroundImage": {},
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass"
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "picture": {},
        "username": "username",
        "status": "status"
      },
      "cid": 1,
      "teaser": {}
    }
  ],
  "filters": [
    {},
    {}
  ],
  "allCategoriesUrl": "allCategoriesUrl",
  "url": "url",
  "selectedFilter": {},
  "tids": [
    "tids",
    "tids"
  ],
  "feeds:disableRSS": 9,
  "loggedIn": true,
  "selectedCategory": {},
  "relative_path": "relative_path",
  "breadcrumbs": [
    {},
    {}
  ]
}

Get popular topics

This api allow the user to get all the popular topics in nodebb

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

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

Header parameters

Response

200400

successful operation

Body

application/json

nextStartinteger

topicCountinteger

topicsarray of discussionForumTopicResponse_topics (object)

tidsarray of string

canPostboolean

showSelectboolean

showTopicToolsboolean

categoriesarray of discussionForumTopicResponse_categories (object)

allCategoriesUrlstring

selectedCategoryobject

selectedCidsarray of string

feeds:disableRSSinteger

rssFeedUrlstring

titlestring

filtersarray of object

selectedFilterobject

termsarray of object

selectedTermobject

paginationobject

breadcrumbsarray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

_headerobject

widgetsobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "template": {},
  "pagination": {},
  "_header": {},
  "nextStart": 0,
  "selectedTerm": {},
  "title": "title",
  "widgets": {},
  "showSelect": true,
  "canPost": true,
  "selectedCids": [
    "selectedCids",
    "selectedCids"
  ],
  "terms": [
    {},
    {}
  ],
  "bodyClass": "bodyClass",
  "topicCount": 6,
  "rssFeedUrl": "rssFeedUrl",
  "categories": [
    {
      "parentCid": 5,
      "color": "color",
      "bgColor": "bgColor",
      "level": "level",
      "name": "name",
      "icon": "icon",
      "selected": true,
      "cid": 4,
      "imageClass": "imageClass"
    },
    {
      "parentCid": 5,
      "color": "color",
      "bgColor": "bgColor",
      "level": "level",
      "name": "name",
      "icon": "icon",
      "selected": true,
      "cid": 4,
      "imageClass": "imageClass"
    }
  ],
  "showTopicTools": true,
  "topics": [
    {
      "pinned": 1,
      "lastposttime": 5,
      "upvotes": 1,
      "unreplied": true,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 7,
      "uid": 3,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 6,
      "isOwner": true,
      "mainPid": 5,
      "locked": 7,
      "slug": "slug",
      "timestamp": 9,
      "ignored": true,
      "index": 1,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 4,
      "postcount": 2,
      "viewcount": 2,
      "titleRaw": "titleRaw",
      "votes": 7,
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "backgroundImage": {},
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass"
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "picture": {},
        "username": "username",
        "status": "status"
      },
      "cid": 1,
      "teaser": {}
    },
    {
      "pinned": 1,
      "lastposttime": 5,
      "upvotes": 1,
      "unreplied": true,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 7,
      "uid": 3,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 6,
      "isOwner": true,
      "mainPid": 5,
      "locked": 7,
      "slug": "slug",
      "timestamp": 9,
      "ignored": true,
      "index": 1,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 4,
      "postcount": 2,
      "viewcount": 2,
      "titleRaw": "titleRaw",
      "votes": 7,
      "category": {
        "parentCid": 6,
        "bgColor": "bgColor",
        "color": "color",
        "backgroundImage": {},
        "name": "name",
        "icon": "icon",
        "slug": "slug",
        "cid": 2,
        "imageClass": "imageClass"
      },
      "user": {
        "uid": 6,
        "icon:bgColor": "icon:bgColor",
        "icon:text": "icon:text",
        "userslug": "userslug",
        "picture": {},
        "username": "username",
        "status": "status"
      },
      "cid": 1,
      "teaser": {}
    }
  ],
  "filters": [
    {},
    {}
  ],
  "allCategoriesUrl": "allCategoriesUrl",
  "url": "url",
  "selectedFilter": {},
  "tids": [
    "tids",
    "tids"
  ],
  "feeds:disableRSS": 9,
  "loggedIn": true,
  "selectedCategory": {},
  "relative_path": "relative_path",
  "breadcrumbs": [
    {},
    {}
  ]
}

Get teaser of topic

This api allow the user to get teaser details of topic in nodebb

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

GEThttps://staging.sunbirded.org/api/discussion/topic/teaser/{topic_id}

Path parameters

topic_id*integer

Header parameters

Response

200400

successful operation

Body

application/json

pidinteger

tidinteger

contentstring

uidinteger

timestampinteger

deletedobject

upvotesinteger

downvotesinteger

repliesinteger

votesinteger

timestampISOstring

userobject

topicobject

categoryobject

isMainPostobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "pid": 0,
  "tid": 0,
  "content": "text",
  "uid": 0,
  "timestamp": 0,
  "upvotes": 0,
  "downvotes": 0,
  "replies": 0,
  "votes": 0,
  "timestampISO": "text",
  "user": {
    "uid": 0,
    "username": "text",
    "userslug": "text",
    "status": "text",
    "displayname": "text",
    "icon:text": "text",
    "icon:bgColor": "text"
  },
  "topic": {
    "uid": 0,
    "tid": 0,
    "title": "text",
    "cid": 0,
    "slug": "text",
    "deleted": 0,
    "postcount": 0,
    "mainPid": 0,
    "titleRaw": "text"
  },
  "category": {
    "cid": 0,
    "name": "text",
    "icon": "text",
    "slug": "text",
    "parentCid": 0,
    "bgColor": "text",
    "color": "text",
    "imageClass": "text"
  }
}

Get topics details

This api allow the user to get topics details by using topicId ad slug from nodebb

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

GEThttps://staging.sunbirded.org/api/discussion/topic/{topic_id}/{slug}

Path parameters

topic_id*integer

slug*string

Header parameters

Response

200400

successful operation

Body

application/json

cidinteger

lastposttimeinteger

mainPidinteger

postcountinteger

slugstring

tidinteger

timestampinteger

titlestring

uidinteger

viewcountinteger

deletedinteger

lockedinteger

pinnedinteger

upvotesinteger

downvotesinteger

deleterUidinteger

titleRawstring

timestampISOstring

lastposttimeISOstring

votesinteger

teaserPidinteger

tagsarray of string

postsarray of object

categoryarray of object

tagWhitelistarray of string

minTagsinteger

maxTagsinteger

thread_toolsarray of string

isFollowingboolean

isNotFollowingboolean

isIgnoringboolean

bookmarkobject

postSharingarray of object

deleterobject

mergerobject

relatedarray of object

unrepliedboolean

iconsarray of object

privilegesobject

topicStaleDaysinteger

reputation:disabledinteger

downvote:disabledinteger

feeds:disableRSSinteger

bookmarkThresholdinteger

necroThresholdinteger

postEditDurationinteger

postDeleteDurationinteger

scrollToMyPostboolean

allowMultipleBadgesboolean

privateUploadsboolean

rssFeedUrlstring

postIndexinteger

breadcrumbsarray of object

paginationobject

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

loggedInUserobject

_headerobject

widgetsobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "privileges": {},
  "upvotes": 7,
  "unreplied": true,
  "privateUploads": true,
  "postDeleteDuration": 6,
  "_header": {},
  "topicStaleDays": 4,
  "teaserPid": 6,
  "loggedInUser": {},
  "posts": [
    {},
    {}
  ],
  "tid": 5,
  "postEditDuration": 9,
  "deleterUid": 1,
  "necroThreshold": 8,
  "mainPid": 1,
  "rssFeedUrl": "rssFeedUrl",
  "locked": 2,
  "slug": "slug",
  "reputation:disabled": 5,
  "downvotes": 1,
  "tags": [
    "tags",
    "tags"
  ],
  "bookmark": {},
  "feeds:disableRSS": 9,
  "isNotFollowing": true,
  "loggedIn": true,
  "downvote:disabled": 9,
  "postIndex": 3,
  "titleRaw": "titleRaw",
  "relative_path": "relative_path",
  "breadcrumbs": [
    {},
    {}
  ],
  "cid": 0,
  "allowMultipleBadges": true,
  "template": {},
  "pinned": 4,
  "pagination": {},
  "lastposttime": 6,
  "bookmarkThreshold": 6,
  "postSharing": [
    {},
    {}
  ],
  "timestampISO": "timestampISO",
  "title": "title",
  "widgets": {},
  "deleter": {},
  "uid": 7,
  "lastposttimeISO": "lastposttimeISO",
  "maxTags": 1,
  "related": [
    {},
    {}
  ],
  "bodyClass": "bodyClass",
  "tagWhitelist": [
    "tagWhitelist",
    "tagWhitelist"
  ],
  "timestamp": 2,
  "minTags": 7,
  "isIgnoring": true,
  "isFollowing": true,
  "scrollToMyPost": true,
  "icons": [
    {},
    {}
  ],
  "url": "url",
  "deleted": 3,
  "postcount": 5,
  "thread_tools": [
    "thread_tools",
    "thread_tools"
  ],
  "viewcount": 9,
  "votes": 1,
  "category": [
    {},
    {}
  ],
  "merger": {}
}

Create new topic

This api allow the user to create new topic in nodebb

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

POSThttps://staging.sunbirded.org/api/discussion/v2/topics

Header parameters

Body

application/json

cid*integer

title*string

content*string

Response

200400

successful operation

Body

application/json

codestring

payloaddiscussionForumCreateTopicResponse_payload (object)

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/topics', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cid": 1,
      "title": "Learning",
      "content": "All Javascript frameworks"
    }),
});
const data = await response.json();

Response

200400

{
  "code": "code",
  "payload": {
    "topicData": {
      "pinned": 4,
      "lastposttime": 6,
      "upvotes": 7,
      "unreplied": 6,
      "mainPost": {},
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 5,
      "uid": 7,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 1,
      "isOwner": true,
      "mainPid": 1,
      "locked": 2,
      "slug": "slug",
      "timestamp": 2,
      "ignored": true,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 3,
      "postcount": 5,
      "viewcount": 9,
      "titleRaw": "titleRaw",
      "votes": 1,
      "category": {},
      "user": {},
      "cid": 0,
      "teaser": {}
    },
    "postData": {
      "isMain": true,
      "bookmarked": true,
      "selfPost": true,
      "index": 9,
      "pid": 7,
      "timestampISO": "timestampISO",
      "display_edit_tools": true,
      "tid": 4,
      "content": "content",
      "uid": 1,
      "display_moderator_tools": true,
      "display_move_tools": true,
      "topic": {},
      "votes": 6,
      "display_delete_tools": true,
      "user": {},
      "timestamp": 5,
      "cid": 9
    }
  }
}

Delete a topic (Soft delete)

This api allow the user to delete a topic in nodebb

• The endpoint for Topics is /v2/topics/{tid}/state
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/topics/{tid}/state

PUThttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/state

Path parameters

tid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "code": "code",
  "payload": {}
}

Follow a topic

This api allow the user to follow a topic in nodebb

• The endpoint for Topics is /v2/topics/{tid}/state
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/topics/{tid}/follow

PUThttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/follow

Path parameters

tid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "code": "code",
  "payload": {}
}

UnFollow a Post

This api allow the user to unfollow a topic in nodebb

• The endpoint for Topics is /v2/topics/{tid}/state
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/topics/{tid}/follow

DELETEhttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/follow

Path parameters

tid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "code": "code",
  "payload": {}
}

Add tags for a topic

This api allow the user to add tags to a topic in nodebb

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

PUThttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/tags

Path parameters

tid*integer

Header parameters

Body

application/json

itemsstring

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/topics/{tid}/tags', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

200400

{
  "code": "code",
  "payload": {}
}

Delete tags for a topic

This api allow the user to delete tags for a topic in nodebb

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

DELETEhttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/tags

Path parameters

tid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "code": "code",
  "payload": {}
}

Pin a topic

This api allow the user to pin to a topic in nodebb

• The endpoint for Topics is /v2/topics/{tid}/pin
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/topics/{tid}/pin

PUThttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/pin

Path parameters

tid*integer

Header parameters

Body

application/json

itemsstring

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/topics/{tid}/pin', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

200400

{
  "code": "code",
  "payload": {}
}

Unpin a topic

This api allow the user to unpin a topic in nodebb

• The endpoint for Topics is /v2/topics/{tid}/pin
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
• Backend Route: http://nodebb-service:4567/discussions/api/v2/topics/{tid}/pin

DELETEhttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}/pin

Path parameters

tid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurlPython

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

Response

200400

{
  "code": "code",
  "payload": {}
}

Updates topic details

This api allow the user to update topic details in nodebb

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

PUThttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}

Path parameters

tid*integer

Header parameters

Body

application/json

pid*integer

content*string

handlestring

titlestring

topic_thumbinteger

tagsarray of string

Response

200400

successful operation

Body

application/json

codestring

payloaddiscussionForumCreateTopicResponse_payload (object)

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/topics/{tid}', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": "Example content",
      "pid": 1,
      "handle": "example",
      "title": "Topic title",
      "topic_thumb": 0,
      "tags": [
        "Angular"
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "code": "code",
  "payload": {
    "topicData": {
      "pinned": 4,
      "lastposttime": 6,
      "upvotes": 7,
      "unreplied": 6,
      "mainPost": {},
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 5,
      "uid": 7,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 1,
      "isOwner": true,
      "mainPid": 1,
      "locked": 2,
      "slug": "slug",
      "timestamp": 2,
      "ignored": true,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 3,
      "postcount": 5,
      "viewcount": 9,
      "titleRaw": "titleRaw",
      "votes": 1,
      "category": {},
      "user": {},
      "cid": 0,
      "teaser": {}
    },
    "postData": {
      "isMain": true,
      "bookmarked": true,
      "selfPost": true,
      "index": 9,
      "pid": 7,
      "timestampISO": "timestampISO",
      "display_edit_tools": true,
      "tid": 4,
      "content": "content",
      "uid": 1,
      "display_moderator_tools": true,
      "display_move_tools": true,
      "topic": {},
      "votes": 6,
      "display_delete_tools": true,
      "user": {},
      "timestamp": 5,
      "cid": 9
    }
  }
}

Create new reply to topic

This api allow the user to create new reply to topic in nodebb

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

POSThttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}

Path parameters

tid*integer

Header parameters

Body

application/json

content*string

toPidinteger

Response

200400

successful operation

Body

application/json

codestring

payloaddiscussionForumCreateTopicResponse_payload (object)

Request

JavaScriptCurlPython

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/topics/{tid}', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "content": "Example reply to topic",
      "toPid": 1
    }),
});
const data = await response.json();

Response

200400

{
  "code": "code",
  "payload": {
    "topicData": {
      "pinned": 4,
      "lastposttime": 6,
      "upvotes": 7,
      "unreplied": 6,
      "mainPost": {},
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 5,
      "uid": 7,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 1,
      "isOwner": true,
      "mainPid": 1,
      "locked": 2,
      "slug": "slug",
      "timestamp": 2,
      "ignored": true,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 3,
      "postcount": 5,
      "viewcount": 9,
      "titleRaw": "titleRaw",
      "votes": 1,
      "category": {},
      "user": {},
      "cid": 0,
      "teaser": {}
    },
    "postData": {
      "isMain": true,
      "bookmarked": true,
      "selfPost": true,
      "index": 9,
      "pid": 7,
      "timestampISO": "timestampISO",
      "display_edit_tools": true,
      "tid": 4,
      "content": "content",
      "uid": 1,
      "display_moderator_tools": true,
      "display_move_tools": true,
      "topic": {},
      "votes": 6,
      "display_delete_tools": true,
      "user": {},
      "timestamp": 5,
      "cid": 9
    }
  }
}

delete topic

This api allow the user to delete topic in nodebb

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

DELETEhttps://staging.sunbirded.org/api/discussion/v2/topics/{tid}

Path parameters

tid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloaddiscussionForumCreateTopicResponse_payload (object)

Request

JavaScriptCurlPython

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

Response

200400

{
  "code": "code",
  "payload": {
    "topicData": {
      "pinned": 4,
      "lastposttime": 6,
      "upvotes": 7,
      "unreplied": 6,
      "mainPost": {},
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "teaserPid": {},
      "tid": 5,
      "uid": 7,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 1,
      "isOwner": true,
      "mainPid": 1,
      "locked": 2,
      "slug": "slug",
      "timestamp": 2,
      "ignored": true,
      "downvotes": 1,
      "icons": {},
      "tags": {},
      "bookmark": {},
      "deleted": 3,
      "postcount": 5,
      "viewcount": 9,
      "titleRaw": "titleRaw",
      "votes": 1,
      "category": {},
      "user": {},
      "cid": 0,
      "teaser": {}
    },
    "postData": {
      "isMain": true,
      "bookmarked": true,
      "selfPost": true,
      "index": 9,
      "pid": 7,
      "timestampISO": "timestampISO",
      "display_edit_tools": true,
      "tid": 4,
      "content": "content",
      "uid": 1,
      "display_moderator_tools": true,
      "display_move_tools": true,
      "topic": {},
      "votes": 6,
      "display_delete_tools": true,
      "user": {},
      "timestamp": 5,
      "cid": 9
    }
  }
}