Sonolus Wiki

GET /sonolus/backgrounds/{name}

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

Query Parameters

Query ParameterValueDescription
localizationstringSee localization.

Request Headers

HeaderValueDescription
Sonolus-Session-IdstringOptional, see Sonolus-Session-Id.
Sonolus-Session-DatastringOptional, see Sonolus-Session-Data.

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 BackgroundDetails = ItemDetails<BackgroundItem>

Examples

{
    "item": {
        // ...
    },
    "description": "Description of the background",
    "recommended": [
        // ...
    ]
}