Skip to content
On this page

Adminserver: Karaoke API

EndpointMethodDescription
/files/parseAndImportKaraokeSongsFromSpreadsheetwebRequestParse and import karaoke songs from spreadsheet
/jsonRpc/karaoke.getKaraokeInfojsonRpcGet karaoke info

Parse and import karaoke songs from spreadsheet

HTTP Method: POST

Path: /files/parseAndImportKaraokeSongsFromSpreadsheet

Description: Endpoint receives karaoke manifest file and imports songs to karaoke index. Endpoint doesn't wait for server to finish work and responds immediately, as import process could take a lot of time (depending on amount of entries). User can check if process was successful by comparing results of karaoke.getKaraokeInfo responses.

Permissions:

all

Request:

multipart form with xslx spreadsheet file

Response:

{ empty }

Get karaoke info

Method: jsonRpc

HTTP Method: POST

Path: /jsonRpc/karaoke.getKaraokeInfo

Permissions:

all

Request:

{ empty }

Response:

{
    "data": {
        "lastAddedAt": timestamp
        "totalCount": int
    }
    "error": { "status": bool, "code": int, "message": string }
}