跳转至

GET /guilds

端点: GET /v1/pdapi/guilds

认证: Bearer 令牌

权限: 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": "人类可读的消息",
        "详情": {}
    }
}
HTTP 错误代码 发生条件
401 INVALID_TOKEN Authorization 头缺失、格式错误,或与配置的 Bearer 令牌不匹配。
403 MISSING_PERMISSION 令牌有效,但不包含此端点权限。
400 INVALID_JSON 提供了请求体,但无法解析为 JSON。
400 REQUEST_FAILED 游戏线程回调抛出异常,或共享玩家/资源解析器失败。
500 REQUEST_TIMEOUT 内部游戏线程回调未在 5 秒内完成。

示例

List all guilds

GET /v1/pdapi/guilds

Refresh guild dashboard data

GET /v1/pdapi/guilds

使用场景

  • Build a guild selector in an admin panel.
  • Find the guild_id for GET /guild.
  • Audit base counts, member counts, and guild ownership at a glance.