Forum APIs

PreviousTopic APIs NextContext Schema

Last updated 2 years ago

Was this helpful?

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

post

/discussion/forum/v2/read

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v2/read' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"type":"course","identifier":"do_12345678996312"}}'

200

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

successful operation

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

post

/discussion/forum/v3/create

Header parameters

Authorizationstringrequired

Body

categoryobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v3/create' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"category":{"name":"Batch 1","pid":567,"description":"Mentors can start discussions","privileges":{"copyFromCategory":268},"context":[{"type":"batch","identifier":"01307806402750054416"}],"subcategories":[{"name":"Annoucements","description":"Only creators can make annoucements","privileges":{"copyFromParent":true}}]}}'

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"
              }
            ]
          }
        ]
      }
    ]
  }
]

successful operation

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

post

/discussion/forum/v2/remove

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v2/remove' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"sbType":"course","sbIdentifier":"do_123456789","cid":[2]}'

200

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

successful operation

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

post

/discussion/forum/v2/uids

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v2/uids' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"sbIdentifiers":["08631a74-4b94-4cf7-a818-831135248a4a"]}}'

200

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

successful operation

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

post

/discussion/forum/v3/groups/users

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v3/groups/users' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"cid":268}}'

200

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

successful operation

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

post

/discussion/forum/v3/group/membership

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v3/group/membership' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"groups":["Category Owner"],"members":[{"sbUserName":"content_reviewer_tn1970","sbUid":"08631a74-4b94-4cf7-a818-831135248a4a"}]}}'

200

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

successful operation

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

post

/discussion/forum/tags

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/tags' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"cids":[2,3]}}'

200

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

successful operation

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

post

/discussion/forum/v3/category/{cid}/privileges

Path parameters

cidintegerrequired

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/forum/v3/category/{cid}/privileges' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"groups":["Category Owner","registered-users"]}}'

200

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

successful operation

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

get

/discussion/tags

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://staging.sunbirded.org/api/discussion/tags' \
  --header 'Authorization: text'

200

400

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

successful operation

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

post

/discussion/tags/list

Header parameters

Authorizationstringrequired

Body

requestobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/tags/list' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"tag":"nodebb","cid":[2,3]}}'

200

400

[
  {
    "unread-class": "unread-class",
    "color": "color",
    "numRecentReplies": 5,
    "icon": "icon",
    "link": "link",
    "description": "description",
    "title": "title",
    "showSelect": true,
    "totalTopicCount": 7,
    "parentCid": 2,
    "maxTags": 2,
    "totalPostCount": 4,
    "bgColor": "bgColor",
    "descriptionParsed": "descriptionParsed",
    "bodyClass": "bodyClass",
    "disabled": 6,
    "rssFeedUrl": "rssFeedUrl",
    "class": "class",
    "slug": "slug",
    "order": 5,
    "minTags": 3,
    "showTopicTools": true,
    "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",
    "cid": 0,
    "tagWhitelist": [
      "tagWhitelist",
      "tagWhitelist"
    ],
    "template": {},
    "privileges": {},
    "pagination": {},
    "_header": {},
    "widgets": {},
    "children": [
      {},
      {}
    ],
    "breadcrumbs": [
      {},
      {}
    ],
    "topics": [
      {
        "pinned": 6,
        "lastposttime": 1,
        "upvotes": 8,
        "unreplied": true,
        "unread": true,
        "timestampISO": "timestampISO",
        "title": "title",
        "tid": 7,
        "uid": 4,
        "lastposttimeISO": "lastposttimeISO",
        "deleterUid": 6,
        "isOwner": true,
        "mainPid": 1,
        "locked": 9,
        "slug": "slug",
        "timestamp": 1,
        "ignored": true,
        "index": 6,
        "downvotes": 9,
        "deleted": 9,
        "postcount": 6,
        "viewcount": 5,
        "titleRaw": "titleRaw",
        "votes": 3,
        "cid": 1,
        "teaserPid": {},
        "icons": {},
        "tags": {},
        "bookmark": {},
        "category": {},
        "user": {},
        "teaser": {}
      },
      {
        "pinned": 6,
        "lastposttime": 1,
        "upvotes": 8,
        "unreplied": true,
        "unread": true,
        "timestampISO": "timestampISO",
        "title": "title",
        "tid": 7,
        "uid": 4,
        "lastposttimeISO": "lastposttimeISO",
        "deleterUid": 6,
        "isOwner": true,
        "mainPid": 1,
        "locked": 9,
        "slug": "slug",
        "timestamp": 1,
        "ignored": true,
        "index": 6,
        "downvotes": 9,
        "deleted": 9,
        "postcount": 6,
        "viewcount": 5,
        "titleRaw": "titleRaw",
        "votes": 3,
        "cid": 1,
        "teaserPid": {},
        "icons": {},
        "tags": {},
        "bookmark": {},
        "category": {},
        "user": {},
        "teaser": {}
      }
    ]
  }
]

successful operation

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

post

/discussion/privileges/v2/copy

Header parameters

Authorizationstringrequired

Body

resultobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/privileges/v2/copy' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"request":{"pid":2,"cid":3}}'

200

400

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

successful operation