Sonolus Wiki

GET /sonolus/effects/{name}

/sonolus/effects/{name} provides detailed information of effect of name {name}, and is used by Sonolus app to populate server effect details view.

Query Parameters

Query ParameterValueDescription
localizationstringSee localization.

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 EffectDetails = ItemDetails<EffectItem>

Examples

{
    "item": {
        // ...
    },
    "description": "Description of the effect",
    "sections": [
        // ...
    ]
}