Query Ranking

Queries rankings recorded in the leaderboard table.

Source Code

playNANOOHandlers.leaderboardRange = function (args) {
    var result = plugin['v20240301'].leaderboard.range({
        parameters: {
            uid: args.uid,
            rangeStart: args.rangeStart,
            rangeEnd: args.rangeEnd
        }
    });

    if (result.statusCode === 200) {
        const parse = JSON.parse(result.body.toString());
        for (key in parse["Items"]) {
            log.debug(parse["Items"][key]["Rank"]);
            log.debug(parse["Items"][key]["RotationCount"]);
            log.debug(parse["Items"][key]["RecordId"]);
            log.debug(parse["Items"][key]["Score"]);
            log.debug(parse["Items"][key]["ExtraData"]);
        }

        return {
            status: "success"
        }
    } else {
        return {
            status: "false"
        }
    }
}

Query Previous Cycle

playNANOOHandlers.leaderboardRangePrev = function (args) {
    var result = plugin['v20240301'].leaderboard.rangePrev({
        parameters: {
            uid: args.uid,
            rotationCount: args.rotationCount,
            rangeStart: args.rangeStart,
            rangeEnd: args.rangeEnd
        }
    });

    if (result.statusCode === 200) {
        const parse = JSON.parse(result.body.toString());
        for (key in parse["Items"]) {
            log.debug(parse["Items"][key]["Rank"]);
            log.debug(parse["Items"][key]["RotationCount"]);
            log.debug(parse["Items"][key]["RecordId"]);
            log.debug(parse["Items"][key]["Score"]);
            log.debug(parse["Items"][key]["ExtraData"]);
        }

        return {
            status: "success"
        }
    } else {
        return {
            status: "false"
        }
    }
}

Request Parameter

Parameter	Description	Type
uid	Table identification code	string
rotationCount	Refresh cycle count	integer
rangeStart	Ranking start range	integer
rangeEnd	Ranking end range	integer

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "Items": [
        {
            "Rank": 1,
            "RotationCount": 1,
            "RecordId": "TEST0001",
            "Score": 20,
            "ExtraData": "ssss"
        }
    ]
}

Response Details

Data Key	Description	Type
Items.Rank	Ranking	integer
Items.RotationCount	Leaderboard table cycle count	integer
Items.RecordId	Record ID	string
Items.Score	Score	integer
Items.ExtraData	Additional data	string