GET /sonolus/{type}/list
/sonolus/{type}/list
provides information of items, and is used by Sonolus app to populate server item list view.
URL Parameters
URL Parameter | Value | Description |
---|---|---|
type | string | posts , playlists , levels , skins , backgrounds , effects , particles , engines , replays , or rooms . |
Query Parameters
Query Parameter | Value | Description |
---|---|---|
localization | string | See localization . |
Configuration Options | any | See Options Query Parameters. |
page | number | See page . |
Search Parameters | any | See Options Query Parameters. |
Search Parameters
When using quick search, search parameters of ?type=quick&keywords=...
will be sent.
Request Headers
Header | Value | Description |
---|---|---|
Sonolus-Session | string | Optional, see Sonolus-Session . |
Request Body
None.
Response Code
Code | Description |
---|---|
200 OK | |
401 Unauthorized | Authentication required or expired. |
Response Headers
Header | Value | Description |
---|---|---|
Sonolus-Version | string | Optional, see Sonolus-Version . |
Response Body
type ServerItemList<T> = {
pageCount: number
items: T[]
searches?: ServerForm[]
}
pageCount
If -1
is used, the list is treated as having infinite pagination.
items
It is recommended to keep each page short by showing only 20 items.
Examples
{
"pageCount": 5,
"items": [
// ...
],
"searches": [
// ...
]
}