Post APIs

PreviousUser APIs NextTopic APIs

Last updated 2 years ago

Was this helpful?

Deletes a post (Soft-delete)

This api allows the user to Deletes a post in the nodebb

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

delete

/discussion/v2/posts/{pid}/state

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}/state' \
  --header 'Authorization: text'

200

400

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

successful operation

Create new post

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

The endpoint for Post 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}

post

/discussion/v2/topics/{tid}

Path parameters

tidintegerrequired

Header parameters

Authorizationstringrequired

Body

contentstringrequired

toPidinteger

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/v2/topics/{tid}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"content":"Example reply to topic","toPid":1}'

200

400

{
  "code": "code",
  "payload": {
    "topicData": {
      "pinned": 4,
      "lastposttime": 6,
      "upvotes": 7,
      "unreplied": 6,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "tid": 5,
      "uid": 7,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 1,
      "isOwner": true,
      "mainPid": 1,
      "locked": 2,
      "slug": "slug",
      "timestamp": 2,
      "ignored": true,
      "downvotes": 1,
      "deleted": 3,
      "postcount": 5,
      "viewcount": 9,
      "titleRaw": "titleRaw",
      "votes": 1,
      "cid": 0,
      "mainPost": {},
      "teaserPid": {},
      "icons": {},
      "tags": {},
      "bookmark": {},
      "category": {},
      "user": {},
      "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,
      "votes": 6,
      "display_delete_tools": true,
      "timestamp": 5,
      "cid": 9,
      "topic": {},
      "user": {}
    }
  }
}

successful operation

Create reply to post

This api allow the user to create reply to post in nodebb

The endpoint for Post 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}

post

/discussion/v2/topics/{tid}

Path parameters

tidintegerrequired

Header parameters

Authorizationstringrequired

Body

contentstringrequired

toPidintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/v2/topics/{tid}' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"content":"Example reply to topic","toPid":1}'

200

400

{
  "code": "code",
  "payload": {
    "topicData": {
      "pinned": 4,
      "lastposttime": 6,
      "upvotes": 7,
      "unreplied": 6,
      "unread": true,
      "timestampISO": "timestampISO",
      "title": "title",
      "tid": 5,
      "uid": 7,
      "lastposttimeISO": "lastposttimeISO",
      "deleterUid": 1,
      "isOwner": true,
      "mainPid": 1,
      "locked": 2,
      "slug": "slug",
      "timestamp": 2,
      "ignored": true,
      "downvotes": 1,
      "deleted": 3,
      "postcount": 5,
      "viewcount": 9,
      "titleRaw": "titleRaw",
      "votes": 1,
      "cid": 0,
      "mainPost": {},
      "teaserPid": {},
      "icons": {},
      "tags": {},
      "bookmark": {},
      "category": {},
      "user": {},
      "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,
      "votes": 6,
      "display_delete_tools": true,
      "timestamp": 5,
      "cid": 9,
      "topic": {},
      "user": {}
    }
  }
}

successful operation

Delete a post by postID

This api allows the user to delete post in the nodebb

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

delete

/discussion/v2/posts/{pid}

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}' \
  --header 'Authorization: text'

200

400

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

successful operation

Vote a post by postID

This api allows the user to vote(Up/down) to post in the nodebb

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

post

/discussion/v2/posts/{pid}/vote

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Body

deltaintegerrequired

delta must be a number. If delta > 0, it's considered an upvote; if delta < 0, it's considered a downvote; otherwise, it's an unvote.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}/vote' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"delta":1}'

200

400

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

successful operation

Remove votes for a post by postID

This api allows the user to delete vote(Up/down) to post in the nodebb

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

delete

/discussion/v2/posts/{pid}/vote

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}/vote' \
  --header 'Authorization: text'

200

400

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

successful operation

Bookmarks a post by postID

This api allows the user to bookmarks a post in the nodebb

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

post

/discussion/v2/posts/{pid}/bookmark

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}/bookmark' \
  --header 'Authorization: text'

200

400

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

successful operation

Removes bookmarks for a post by postID

This api allows the user to Unbookmarks a post in the nodebb

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

delete

/discussion/v2/posts/{pid}/bookmark

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}/bookmark' \
  --header 'Authorization: text'

200

400

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

successful operation

Restores a post

This api allows the user to Restores a post in the nodebb

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

put

/discussion/v2/posts/{pid}/state

Path parameters

pidintegerrequired

Header parameters

Authorizationstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://staging.sunbirded.org/api/discussion/v2/posts/{pid}/state' \
  --header 'Authorization: text'

200

400

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

successful operation