Sonolus Wiki

GET /sonolus/{type}/{itemName}/community/comments/list

/sonolus/{type}/{itemName}/community/comments/list provides comments information of item of name {itemName}, and is used by Sonolus app to populate server item details view's community section's comment list.

URL Parameters

URL ParameterValueDescription
typestringposts, playlists, levels, skins, backgrounds, effects, particles, engines, or replays.
itemNamestringName of item.

Query Parameters

Query ParameterValueDescription
localizationstringSee localization.
Configuration OptionsanySee Options Query Parameters.
pagenumberSee page.

Request Headers

HeaderValueDescription
Sonolus-SessionstringOptional, see Sonolus-Session.

Request Body

None.

Response Code

CodeDescription
200 OK
401 UnauthorizedAuthentication required or expired.
404 Not Found

Response Headers

HeaderValueDescription
Sonolus-VersionstringOptional, see Sonolus-Version.

Response Body

type ServerItemCommunityCommentList = {
    pageCount: number
    comments: ServerItemCommunityComment[]
}

pageCount

If -1 is used, the list is treated as having infinite pagination.

comments

It is recommended to keep each page short by showing only 10 comments.

Examples

{
    "pageCount": 5,
    "comments": [
        // ...
    ]
}