GetRankList

public BackendReturnObject GetRankList(string rankUuid);
public BackendReturnObject GetRankList(string rankUuid, int limit);
public BackendReturnObject GetRankList(string rankUuid, int limit, int offset);

Grouped leaderboard unavailable

The URank ranking method can only look up NULL groups in grouped leaderboards.
If you want to check leaderboards according to groups, use the Leaderboard method.

Parameters

Value	Type	Description	Default
rankUuid	string	uuid of the ranking to look up	-
limit	int	Number of guilds to look up (1 - 50)	10
offset	int	Starting point of the ranking to look up (0 or more)	0

The rankUuid value can be checked using the following methods:

• Create a ranking in BACKND Console and check the uuid value from the information of the ranking
• Check the uuid value using the Look up ranking information of all guilds method

Description

Looks up list of guilds registered in the ranking using a uuid value.

Example

Synchronous

// Look up the 1st - 10th guilds in the rankUuid ranking
Backend.URank.Guild.GetRankList("rankUuid");
// Look up the 1st - 100th guilds in the rankUuid ranking
Backend.URank.Guild.GetRankList("rankUuid", 100);
// Look up the 11th - 20th guilds in the rankUuid ranking
Backend.URank.Guild.GetRankList("rankUuid", 10, 10);

Asynchronous

// Look up the 1st - 10th guilds in the rankUuid ranking
Backend.URank.Guild.GetRankList("rankUuid", callback=> {
    // Post-process
});
// Look up the 1st - 100th guilds in the rankUuid ranking
Backend.URank.Guild.GetRankList("rankUuid", 100, callback=> {
    // Post-process
});
// Look up the 11th - 20th guilds in the rankUuid ranking
Backend.URank.Guild.GetRankList("rankUuid", 10, 10, callback=> {
    // Post-process
});

SendQueue

// Look up the 1st - 10th guilds in the rankUuid ranking
SendQueue.Enqueue(Backend.URank.Guild.GetRankList, "rankUuid", callback=> {
    // Post-process
});
// Look up the 1st - 100th guilds in the rankUuid ranking
SendQueue.Enqueue(Backend.URank.Guild.GetRankList, "rankUuid", 100, callback=> {
    // Post-process
});
// Look up the 11th - 20th guilds in the rankUuid ranking
SendQueue.Enqueue(Backend.URank.Guild.GetRankList, "rankUuid", 10, 10, callback=> {
    // Post-process
});

ReturnCase

Success cases

When the lookup is successful
statusCode : 200
message : Success
returnValue : refer to GetReturnValuetoJSON

When the lookup is successful but the rank holder is not in the lookup range
statusCode : 200
message : Success
returnValue : {"rows":[]}

Error cases

When the uuid is null or string.Empty
statusCode : 400
errorCode : ValidationException
message : rankUuid is null or empty

When the uuid does not exist
statusCode : 404
errorCode : NotFoundException
message : rank not found, rank cannot be found

GetReturnValuetoJSON

GetReturnValuetoJSON

{
    "rows": [
        {
            // Guild name
            "guildName": {
                "S": "guildName"
            },
            // Guild inDate
            "guildInDate": {
                "S": "2021-03-11T03:23:24.913Z"
            },
            // Guild score
            // All 'score', regardless of meta rankings and goods rankings.  
            "score": {
                "N": "9999"
            },
            // offset 
            "index": {
                "N": 0
            },
            // Guild's ranking
            "rank": {
                "N": 1
            }
        },
        // and etc...  
    ],
    // Total number of guilds registered in the ranking
    "totalCount": 100
}

Sample Code

public class GuildRankItem
{
    public string guildInDate;
    public string guildName;
    public string score;
    public string index;
    public string rank;
    public string totalCount;

    public override string ToString()
    {
        return $"guildInDate:{guildInDate}\nGuild name:{guildName}\nScore:{score}\nSort:{index}\nRank:{rank}\nTotal:{totalCount}\n";
    }
}

public void GetRankListTest()
{
    int limit = 43;

    List<GuildRankItem> rankItemList = new List<GuildRankItem>();

    BackendReturnObject bro = Backend.URank.Guild.GetRankList(userUuid, limit);

    if(bro.IsSuccess())
    {
        LitJson.JsonData rankListJson = bro.GetFlattenJSON();
        for(int i = 0; i < rankListJson["rows"].Count; i++)
        {
            GuildRankItem rankItem = new GuildRankItem();

            rankItem.guildInDate = rankListJson["rows"][i]["guildInDate"].ToString();
            rankItem.guildName = rankListJson["rows"][i]["guildName"].ToString();
            rankItem.score = rankListJson["rows"][i]["score"].ToString();
            rankItem.index = rankListJson["rows"][i]["index"].ToString();
            rankItem.rank = rankListJson["rows"][i]["rank"].ToString();
            rankItem.totalCount = rankListJson["totalCount"].ToString();

            rankItemList.Add(rankItem);
            Debug.Log(rankItem.ToString());
        }
    }
}