GET /api/search/player
| パラメータ名 |
型 |
概要 |
| q |
文字列 |
検索クエリ |
| lim |
整数 |
検索結果数の上限(1以上20以下) |
| パラメータ名 |
型 |
概要 |
| result_count |
整数 |
結果の総数 |
| query |
文字列 |
検索クエリ |
| players |
IPlayerの配列 |
検索結果 |
GET /api/ranking
| パラメータ名 |
型 |
概要 |
| type |
文字列 |
ランキングの種類 ("break"/"build"/"playtime"/"vote"を想定)、デフォルトで"break" |
| duration |
文字列 |
ランキングの種類（"daily"/"weekly"/"monthly"/"yearly"） |
| offset |
整数 |
結果の順位の下限(0以上)、デフォルトで0 |
| lim |
整数 |
結果のサイズ上限(1以上100以下)、デフォルトで100 |
| パラメータ名 |
型 |
概要 |
| result_count |
整数 |
結果の総数 |
| ranks |
IPlayerRankの配列 |
ランク順でソートされたランキング配列 |
| total_ranked_player |
整数 |
ランキングに含まれるプレーヤーの総数 |
例えば、/api/ranking?offset=11&limit=5 にGETリクエストを投げると、戻り値は整地量ランキングの11位から15位の情報であることが想定される。
ここで、もしプレーヤーが15人いなかった場合、最下位のプレーヤーまでを返すようにすればよい(なので、戻り値のresult_countは必ずしもパラメータのlimとは同じではないことになる)。
GET /api/ranking/player/{player.uuid}
| パラメータ名 |
型 |
概要 |
| types |
文字列 |
ランキングの種類 ("break"/"build"/"playtime"/"vote"を想定、デフォルトでこれらすべて) |
例えば、/api/ranking/player/Notch?types=break,build にリクエストを投げると、戻り値はプレーヤーNotchの整地量/建築量でのランキング情報を返すことが想定される。
https://ranking-gigantic.seichi.click/api/ranking/player/b66cc3f6-a045-42ad-b4b8-320f20caf140?types=break,build,playtime,vote
プレーヤーの基本情報を表します。
| パラメータ名 |
型 |
概要 |
| name |
文字列 |
プレーヤー名 |
| uuid |
文字列 |
プレーヤーUUID |
プレーヤーのランキングでの順位を表します。
| パラメータ名 |
型 |
概要 |
| rank |
整数 |
順位 |
| type |
文字列 |
ランキングの種類 |
| data |
IPlayerData |
ランキング作成時の比較に用いられたPlayerData |
| player_lastquit |
文字列 |
文字列化された最終ログアウト時刻 |
| player |
IPlayer |
プレーヤー |
typeがplaytimeの時は、次のオブジェクトがdata.dataに格納される：
| パラメータ名 |
型 |
概要 |
| hours |
整数 |
プレイした時間の時間の部分 |
| minutes |
整数 |
プレイした時間の分の部分 |
| seconds |
整数 |
プレイした時間の秒の部分 |
プレーヤーデータを表します。
| パラメータ名 |
型 |
概要 |
| raw_data |
文字列 |
文字列化された生のデータ |
| data |
オブジェクト(optional) |
加工済みデータ |