Sonolus Wiki

GET /sonolus/effects/list

/sonolus/effects/list provides information of effects, and is used by Sonolus app to populate server effect list view.

Query Parameters

Query ParameterValueDescription
localizationstringSee localization.
pagenumberSee page.
Search ParametersanySee Options Query Parameters.

Request Headers

HeaderValueDescription
Sonolus-SessionstringOptional, see Sonolus-Session.

Request Body

None.

Response Code

CodeDescription
200 OK
401 UnauthorizedAuthentication required or expired.

Response Headers

HeaderValueDescription
Sonolus-VersionstringOptional, see Sonolus-Version.

Response Body

type EffectList = ItemList<EffectItem>

Examples

{
    "pageCount": 5,
    "items": [
        // ...
    ],
    "searches": [
        // ...
    ]
}

Remarks

When using quick search, search parameters of ?type=quick&keywords=... will be sent.