コンテンツにスキップ

GET /guilds

エンドポイント: GET /v1/pdapi/guilds

認証: ベアラートークン

許可: REST.Guilds.Read

目的

既知のギルドと概要情報をリストします。特定のギルドをリクエストする前に、このエンドポイントを使用してギルド ID を検出します。

パスパラメータ

なし。

クエリパラメータ

なし。

リクエストボディ

リクエスト本文がありません。

応答スキーマ

200 response schema

Field Type Description
Meta object Guild list metadata.
Guilds object Known guild summaries keyed by guild UUID.

Meta object schema:

Field Type Description
GuildCount integer Number of guilds returned.

Guild summary object schema:

Field Type Description
name string Guild name.
Level integer Guild base camp level.
admin object Guild admin details.
camp_count integer Number of base camps in the guild.
camps object[] Base camp summaries.
member_count integer Number of guild members.
members string[] Guild member PlayerUID values.

admin object schema:

Field Type Description
id string Admin PlayerUID.
name string Admin player name.

camps[] item schema:

Field Type Description
id string Base camp GUID.
world_pos object Base camp world coordinates.
map_pos object Converted map coordinates.

Coordinate object schema:

Field Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

エラー応答

エラー本体は次の形状を使用します。

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP エラーコード それが起こったとき
401 INVALID_TOKEN Authorization ヘッダーが欠落しているか、形式が不正であるか、構成されたベアラー トークンと一致しません。
403 MISSING_PERMISSION トークンは有効ですが、このエンドポイント権限が含まれていません。
400 INVALID_JSON リクエスト本文が指定されましたが、JSON として解析できませんでした。
400 REQUEST_FAILED ゲーム スレッド コールバックが例外をスローしたか、共有プレーヤー/リソース リゾルバーが失敗しました。
500 REQUEST_TIMEOUT 内部ゲーム スレッド コールバックは 5 秒以内に完了しませんでした。

例

すべてのギルドをリストする

GET /v1/pdapi/guilds

ギルドダッシュボードデータを更新する

GET /v1/pdapi/guilds

シナリオ

  • 管理パネルにギルドセレクターを構築します。
  • GET /guild の guild_id を見つけます。
  • 拠点数、メンバー数、ギルドの所有権を一目で監査します。