User APIs

Fetch nodebb user details

This api is used for fetching the user details based on user slug from nodebb.

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

GEThttps://staging.sunbirded.org/api/discussion/user/{userslug}

Path parameters

userslug*string

Header parameters

Response

200400

successful operation

Body

application/json

uidstring

usernamestring

userslugstring

emailstring

email:confirmedboolean

joindateinteger

lastonlineinteger

fullnamestring

locationstring

birthdaystring

websitestring

aboutmestring

signaturestring

uploadedpicturestring

profileviewsinteger

reputationinteger

postcountinteger

topiccountinteger

lastposttimeinteger

bannedboolean

banned:expireinteger

statusstring

flagsstring

followerCountinteger

followingCountinteger

cover:urlstring

cover:positionstring

groupTitlestring

groupTitleArrayarray of string

icon:textstring

icon:bgColorboolean

joindateISOstring

lastonlineISOstring

banned_untilinteger

banned_until_readablestring

aboutmeParsedstring

ageinteger

emailClassstring

ipsobject

isBlockedboolean

blocksCountboolean

youridinteger

theiridinteger

isTargetAdminboolean

isAdminboolean

isGlobalModeratorboolean

isModeratorboolean

isAdminOrGlobalModeratorboolean

isAdminOrGlobalModeratorOrModeratorboolean

isSelfOrAdminOrGlobalModeratorboolean

canEditboolean

canBanboolean

canChangePasswordboolean

isSelfboolean

isFollowingboolean

hasPrivateChatinteger

showHiddenboolean

groupsarray of object

disableSignaturesboolean

reputation:disabledboolean

downvote:disabledboolean

profile_linksarray of object

ssoarray of object

websiteLinkstring

websiteNamestring

moderationNotestring

username:disableEditboolean

email:disableEditboolean

postsarray of discussionForumUserDetails_posts (object)

latestPostsarray of discussionForumUserDetails_posts (object)

bestPostsarray of discussionForumUserDetails_posts (object)

breadcrumbsarray of object

titlestring

allowCoverPictureboolean

selectedGrouparray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

widgetsobject

_headerobject

Request

JavaScriptCurl

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

Response

{
  "websiteLink": "websiteLink",
  "_header": {},
  "reputation": 5,
  "blocksCount": true,
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    }
  ],
  "sso": [
    {},
    {}
  ],
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "profile_links": [
    {},
    {}
  ],
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "ips": {},
  "latestPosts": [
    null,
    null
  ],
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "breadcrumbs": [
    {},
    {}
  ],
  "status": "status",
  "birthday": "birthday",
  "template": {},
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "bestPosts": [
    null,
    null
  ],
  "title": "title",
  "widgets": {},
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "selectedGroup": [
    {},
    {}
  ],
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "groups": [
    {},
    {}
  ],
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username"
}

Fetch nodebb user details by using uid

This api is used for fetching the user details based on nodebb uid.

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

GEThttps://staging.sunbirded.org/api/discussion/user/uid/{uid}

Path parameters

uid*string

Header parameters

Response

200400

successful operation

Body

application/json

uidnumber

usernamestring

userslugstring

email:confirmednumber

joindatenumber

lastonlinenumber

pictureobject

locationobject

birthdayobject

websiteobject

aboutmeobject

signatureobject

uploadedpictureobject

profileviewsnumber

reputationnumber

postcountnumber

topiccountnumber

lastposttimenumber

bannednumber

banned:expirenumber

statusstring

flagsobject

followerCountnumber

followingCountnumber

cover:urlobject

cover:positionobject

groupTitleobject

sunbird-oidcIdobject

displaynamestring

groupTitleArrayobject

icon:textstring

icon:bgColorstring

joindateISOstring

lastonlineISOstring

banned_untilnumber

banned_until_readablestring

Request

JavaScriptCurl

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

Response

{
  "uid": 0,
  "username": "text",
  "userslug": "text",
  "email:confirmed": 0,
  "joindate": 0,
  "lastonline": 0,
  "profileviews": 0,
  "reputation": 0,
  "postcount": 0,
  "topiccount": 0,
  "lastposttime": 0,
  "banned": 0,
  "banned:expire": 0,
  "status": "text",
  "followerCount": 0,
  "followingCount": 0,
  "displayname": "text",
  "icon:text": "text",
  "icon:bgColor": "text",
  "joindateISO": "text",
  "lastonlineISO": "text",
  "banned_until": 0,
  "banned_until_readable": "text"
}

Fetch user upvoted posts list

This api is used for fetching the user upvote details from nodebb.

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

GEThttps://staging.sunbirded.org/api/discussion/user/{userslug}/upvoted

Path parameters

userslug*string

Header parameters

Response

200400

successful operation

Body

application/json

uidstring

usernamestring

userslugstring

emailstring

email:confirmedboolean

joindateinteger

lastonlineinteger

fullnamestring

locationstring

birthdaystring

websitestring

aboutmestring

signaturestring

uploadedpicturestring

profileviewsinteger

reputationinteger

postcountinteger

topiccountinteger

lastposttimeinteger

bannedboolean

banned:expireinteger

statusstring

flagsstring

followerCountinteger

followingCountinteger

cover:urlstring

cover:positionstring

groupTitlestring

groupTitleArrayarray of string

icon:textstring

icon:bgColorboolean

joindateISOstring

lastonlineISOstring

banned_untilinteger

banned_until_readablestring

aboutmeParsedstring

ageinteger

emailClassstring

ipsobject

isBlockedboolean

blocksCountboolean

youridinteger

theiridinteger

isTargetAdminboolean

isAdminboolean

isGlobalModeratorboolean

isModeratorboolean

isAdminOrGlobalModeratorboolean

isAdminOrGlobalModeratorOrModeratorboolean

isSelfOrAdminOrGlobalModeratorboolean

canEditboolean

canBanboolean

canChangePasswordboolean

isSelfboolean

isFollowingboolean

hasPrivateChatinteger

showHiddenboolean

groupsarray of object

disableSignaturesboolean

reputation:disabledboolean

downvote:disabledboolean

profile_linksarray of object

ssoarray of object

websiteLinkstring

websiteNamestring

moderationNotestring

username:disableEditboolean

email:disableEditboolean

postsarray of discussionForumUserDetails_posts (object)

latestPostsarray of discussionForumUserDetails_posts (object)

bestPostsarray of discussionForumUserDetails_posts (object)

breadcrumbsarray of object

titlestring

allowCoverPictureboolean

selectedGrouparray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

widgetsobject

_headerobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/user/{userslug}/upvoted', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "websiteLink": "websiteLink",
  "_header": {},
  "reputation": 5,
  "blocksCount": true,
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    }
  ],
  "sso": [
    {},
    {}
  ],
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "profile_links": [
    {},
    {}
  ],
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "ips": {},
  "latestPosts": [
    null,
    null
  ],
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "breadcrumbs": [
    {},
    {}
  ],
  "status": "status",
  "birthday": "birthday",
  "template": {},
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "bestPosts": [
    null,
    null
  ],
  "title": "title",
  "widgets": {},
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "selectedGroup": [
    {},
    {}
  ],
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "groups": [
    {},
    {}
  ],
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username"
}

Fetch user downvoted posts list

This api is used for fetching the user down vote details from nodebb.

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

GEThttps://staging.sunbirded.org/api/discussion/user/{userslug}/downvoted

Path parameters

userslug*string

Header parameters

Response

200400

successful operation

Body

application/json

uidstring

usernamestring

userslugstring

emailstring

email:confirmedboolean

joindateinteger

lastonlineinteger

fullnamestring

locationstring

birthdaystring

websitestring

aboutmestring

signaturestring

uploadedpicturestring

profileviewsinteger

reputationinteger

postcountinteger

topiccountinteger

lastposttimeinteger

bannedboolean

banned:expireinteger

statusstring

flagsstring

followerCountinteger

followingCountinteger

cover:urlstring

cover:positionstring

groupTitlestring

groupTitleArrayarray of string

icon:textstring

icon:bgColorboolean

joindateISOstring

lastonlineISOstring

banned_untilinteger

banned_until_readablestring

aboutmeParsedstring

ageinteger

emailClassstring

ipsobject

isBlockedboolean

blocksCountboolean

youridinteger

theiridinteger

isTargetAdminboolean

isAdminboolean

isGlobalModeratorboolean

isModeratorboolean

isAdminOrGlobalModeratorboolean

isAdminOrGlobalModeratorOrModeratorboolean

isSelfOrAdminOrGlobalModeratorboolean

canEditboolean

canBanboolean

canChangePasswordboolean

isSelfboolean

isFollowingboolean

hasPrivateChatinteger

showHiddenboolean

groupsarray of object

disableSignaturesboolean

reputation:disabledboolean

downvote:disabledboolean

profile_linksarray of object

ssoarray of object

websiteLinkstring

websiteNamestring

moderationNotestring

username:disableEditboolean

email:disableEditboolean

postsarray of discussionForumUserDetails_posts (object)

latestPostsarray of discussionForumUserDetails_posts (object)

bestPostsarray of discussionForumUserDetails_posts (object)

breadcrumbsarray of object

titlestring

allowCoverPictureboolean

selectedGrouparray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

widgetsobject

_headerobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/user/{userslug}/downvoted', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "websiteLink": "websiteLink",
  "_header": {},
  "reputation": 5,
  "blocksCount": true,
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    }
  ],
  "sso": [
    {},
    {}
  ],
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "profile_links": [
    {},
    {}
  ],
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "ips": {},
  "latestPosts": [
    null,
    null
  ],
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "breadcrumbs": [
    {},
    {}
  ],
  "status": "status",
  "birthday": "birthday",
  "template": {},
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "bestPosts": [
    null,
    null
  ],
  "title": "title",
  "widgets": {},
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "selectedGroup": [
    {},
    {}
  ],
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "groups": [
    {},
    {}
  ],
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username"
}

Fetch user bookmarked posts

This api is used for fetching the user bookmark post details from nodebb.

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

GEThttps://staging.sunbirded.org/api/discussion/user/{userslug}/bookmarks

Path parameters

userslug*string

Header parameters

Response

200400

successful operation

Body

application/json

uidstring

usernamestring

userslugstring

emailstring

email:confirmedboolean

joindateinteger

lastonlineinteger

fullnamestring

locationstring

birthdaystring

websitestring

aboutmestring

signaturestring

uploadedpicturestring

profileviewsinteger

reputationinteger

postcountinteger

topiccountinteger

lastposttimeinteger

bannedboolean

banned:expireinteger

statusstring

flagsstring

followerCountinteger

followingCountinteger

cover:urlstring

cover:positionstring

groupTitlestring

groupTitleArrayarray of string

icon:textstring

icon:bgColorboolean

joindateISOstring

lastonlineISOstring

banned_untilinteger

banned_until_readablestring

aboutmeParsedstring

ageinteger

emailClassstring

ipsobject

isBlockedboolean

blocksCountboolean

youridinteger

theiridinteger

isTargetAdminboolean

isAdminboolean

isGlobalModeratorboolean

isModeratorboolean

isAdminOrGlobalModeratorboolean

isAdminOrGlobalModeratorOrModeratorboolean

isSelfOrAdminOrGlobalModeratorboolean

canEditboolean

canBanboolean

canChangePasswordboolean

isSelfboolean

isFollowingboolean

hasPrivateChatinteger

showHiddenboolean

groupsarray of object

disableSignaturesboolean

reputation:disabledboolean

downvote:disabledboolean

profile_linksarray of object

ssoarray of object

websiteLinkstring

websiteNamestring

moderationNotestring

username:disableEditboolean

email:disableEditboolean

postsarray of discussionForumUserDetails_posts (object)

latestPostsarray of discussionForumUserDetails_posts (object)

bestPostsarray of discussionForumUserDetails_posts (object)

breadcrumbsarray of object

titlestring

allowCoverPictureboolean

selectedGrouparray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

widgetsobject

_headerobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/user/{userslug}/bookmarks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "websiteLink": "websiteLink",
  "_header": {},
  "reputation": 5,
  "blocksCount": true,
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    }
  ],
  "sso": [
    {},
    {}
  ],
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "profile_links": [
    {},
    {}
  ],
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "ips": {},
  "latestPosts": [
    null,
    null
  ],
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "breadcrumbs": [
    {},
    {}
  ],
  "status": "status",
  "birthday": "birthday",
  "template": {},
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "bestPosts": [
    null,
    null
  ],
  "title": "title",
  "widgets": {},
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "selectedGroup": [
    {},
    {}
  ],
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "groups": [
    {},
    {}
  ],
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username"
}

Fetch user recent posts

This api is used for fetching the user recent post details from nodebb.

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

GEThttps://staging.sunbirded.org/api/discussion/user/{userslug}/posts

Path parameters

userslug*string

Header parameters

Response

200400

successful operation

Body

application/json

uidstring

usernamestring

userslugstring

emailstring

email:confirmedboolean

joindateinteger

lastonlineinteger

fullnamestring

locationstring

birthdaystring

websitestring

aboutmestring

signaturestring

uploadedpicturestring

profileviewsinteger

reputationinteger

postcountinteger

topiccountinteger

lastposttimeinteger

bannedboolean

banned:expireinteger

statusstring

flagsstring

followerCountinteger

followingCountinteger

cover:urlstring

cover:positionstring

groupTitlestring

groupTitleArrayarray of string

icon:textstring

icon:bgColorboolean

joindateISOstring

lastonlineISOstring

banned_untilinteger

banned_until_readablestring

aboutmeParsedstring

ageinteger

emailClassstring

ipsobject

isBlockedboolean

blocksCountboolean

youridinteger

theiridinteger

isTargetAdminboolean

isAdminboolean

isGlobalModeratorboolean

isModeratorboolean

isAdminOrGlobalModeratorboolean

isAdminOrGlobalModeratorOrModeratorboolean

isSelfOrAdminOrGlobalModeratorboolean

canEditboolean

canBanboolean

canChangePasswordboolean

isSelfboolean

isFollowingboolean

hasPrivateChatinteger

showHiddenboolean

groupsarray of object

disableSignaturesboolean

reputation:disabledboolean

downvote:disabledboolean

profile_linksarray of object

ssoarray of object

websiteLinkstring

websiteNamestring

moderationNotestring

username:disableEditboolean

email:disableEditboolean

postsarray of discussionForumUserDetails_posts (object)

latestPostsarray of discussionForumUserDetails_posts (object)

bestPostsarray of discussionForumUserDetails_posts (object)

breadcrumbsarray of object

titlestring

allowCoverPictureboolean

selectedGrouparray of object

loggedInboolean

relative_pathstring

templateobject

urlstring

bodyClassstring

widgetsobject

_headerobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/user/{userslug}/posts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "websiteLink": "websiteLink",
  "_header": {},
  "reputation": 5,
  "blocksCount": true,
  "posts": [
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    },
    {
      "upvotes": 5,
      "pid": 6,
      "timestampISO": "timestampISO",
      "downvotes": 9,
      "tid": 7,
      "content": "content",
      "uid": 1,
      "deleted": true,
      "isMainPost": true,
      "topic": {
        "uid": 8,
        "deleted": 3,
        "postcount": 6,
        "titleRaw": "titleRaw",
        "mainPid": 1,
        "title": "title",
        "teaserPid": {},
        "tid": 9,
        "slug": "slug",
        "cid": 6
      },
      "votes": 9,
      "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"
      },
      "timestamp": 4
    }
  ],
  "sso": [
    {},
    {}
  ],
  "icon:text": "icon:text",
  "isGlobalModerator": true,
  "joindate": 0,
  "profile_links": [
    {},
    {}
  ],
  "reputation:disabled": true,
  "banned_until_readable": "banned_until_readable",
  "allowCoverPicture": true,
  "isAdmin": true,
  "moderationNote": "moderationNote",
  "ips": {},
  "latestPosts": [
    null,
    null
  ],
  "aboutme": "aboutme",
  "email:confirmed": true,
  "isTargetAdmin": true,
  "isAdminOrGlobalModerator": true,
  "emailClass": "emailClass",
  "loggedIn": true,
  "downvote:disabled": true,
  "topiccount": 2,
  "relative_path": "relative_path",
  "isSelf": true,
  "breadcrumbs": [
    {},
    {}
  ],
  "status": "status",
  "birthday": "birthday",
  "template": {},
  "showHidden": true,
  "yourid": 1,
  "lastposttime": 7,
  "isModerator": true,
  "signature": "signature",
  "icon:bgColor": true,
  "canEdit": true,
  "flags": "flags",
  "groupTitle": "groupTitle",
  "isBlocked": true,
  "bestPosts": [
    null,
    null
  ],
  "title": "title",
  "widgets": {},
  "followingCount": 2,
  "lastonlineISO": "lastonlineISO",
  "email:disableEdit": true,
  "uid": "uid",
  "groupTitleArray": [
    "groupTitleArray",
    "groupTitleArray"
  ],
  "canChangePassword": true,
  "profileviews": 1,
  "bodyClass": "bodyClass",
  "cover:url": "cover:url",
  "selectedGroup": [
    {},
    {}
  ],
  "banned": true,
  "banned_until": 4,
  "userslug": "userslug",
  "followerCount": 3,
  "email": "email",
  "website": "website",
  "isFollowing": true,
  "uploadedpicture": "uploadedpicture",
  "canBan": true,
  "lastonline": 6,
  "disableSignatures": true,
  "banned:expire": 9,
  "groups": [
    {},
    {}
  ],
  "username:disableEdit": true,
  "joindateISO": "joindateISO",
  "url": "url",
  "isSelfOrAdminOrGlobalModerator": true,
  "websiteName": "websiteName",
  "hasPrivateChat": 1,
  "isAdminOrGlobalModeratorOrModerator": true,
  "cover:position": "cover:position",
  "postcount": 5,
  "location": "location",
  "fullname": "fullname",
  "aboutmeParsed": "aboutmeParsed",
  "age": 7,
  "theirid": 1,
  "username": "username"
}

Create new user in nodebb using write api plugin

This api is used for creating the user in nodebb using write api plugin.

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

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

Header parameters

Body

application/json

usernamestring

emailstring

passwordstring

Response

200400

successful operation

Body

application/json

codestring

payloaddiscussionForumCreateUserResponse_payload (object)

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "username": "Vinu Kumar",
      "email": "[e-mail]",
      "password": "Test@123"
    }),
});
const data = await response.json();

Response

{
  "code": "code",
  "payload": {
    "uid": 0
  }
}

Create new user in nodebb Sunbird OIDC

This api is used for creating the user in nodebb usig Sunbird OIDC plugin.

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

POSThttps://staging.sunbirded.org/api/discussion/user/v1/create

Header parameters

Body

application/json

requestobject

Response

200400

successful operation

Body

application/json

idstring

verstring

paramsobject

responseCodestring

resultobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/user/v1/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "example": {
          "id": "api.discussions.user.create",
          "ver": 1,
          "params": {
            "resmsgid": null,
            "msgid": null,
            "status": "unsuccessful",
            "msg": "User already Exists"
          },
          "responseCode": 400,
          "result": {
            "userId": {
              "uid": 1
            },
            "userSlug": "content_creator_tn3941",
            "userName": "content_creator_tn3941"
          }
        }
      }
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "ver": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "status": "text",
    "msg": "text"
  },
  "responseCode": "text",
  "result": {
    "userId": {},
    "userSlug": "text",
    "userName": "text"
  }
}

Updates a user's profile information

This api is used to update user's profile information in nodebb.

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

PUThttps://staging.sunbirded.org/api/discussion/v2/users/{uid}

Path parameters

uid*integer

Header parameters

Body

application/json

usernamestring

emailstring

fullnamestring

websitestring

locationstring

birthdaystring

signaturestring

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/users/{uid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "username": "Venkat",
      "email": "[e-mail]",
      "fullname": "venkat kadiveti",
      "website": "https://example.org/",
      "location": "Bangalore",
      "birthday": "02/04/1995",
      "signature": "venkat"
    }),
});
const data = await response.json();

Response

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

Deletes a user from nodebb

This api is used for deleting user in nodebb.

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

DELETEhttps://staging.sunbirded.org/api/discussion/v2/users/{uid}

Path parameters

uid*integer

Header parameters

Response

200400

successful operation

Body

application/json

codestring

payloadobject

Request

JavaScriptCurl

const response = await fetch('https://staging.sunbirded.org/api/discussion/v2/users/{uid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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