跳转至

GET /guilds

端点: GET /v1/pdapi/guilds

认证: Bearer 令牌

权限: REST.Guilds.Read

用途

列出已知公会及摘要信息。请求特定公会前可使用此端点查找公会 ID。

路径参数

无。

查询参数

无。

请求体

无请求体。

响应结构

200 响应架构

字段 类型 描述
Meta object 公会列表元数据。
Guilds object 以公会 UUID 为键的已知公会摘要。

Meta 对象架构:

字段 类型 描述
GuildCount integer 返回的公会数量。

公会摘要对象架构:

字段 类型 描述
name string 公会名称。
Level integer 公会基地等级。
admin object 公会管理员详情。
camp_count integer 公会中的基地数量。
camps object[] 基地摘要。
member_count integer 公会成员数量。
members string[] 公会成员的 PlayerUID 值。

admin 对象架构:

字段 类型 描述
id string 管理员 PlayerUID。
name string 管理员玩家名称。

camps[] 条目架构:

字段 类型 描述
id string 基地 GUID。
world_pos object 基地世界坐标。
map_pos object 转换后的地图坐标。

坐标对象架构:

字段 类型 描述
x number X 坐标。
y number Y 坐标。
z number Z 坐标。

错误响应

错误响应使用以下格式:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "人类可读的消息",
        "Details": {}
    }
}
HTTP 错误代码 发生条件
401 INVALID_TOKEN Authorization 头缺失、格式错误,或与配置的 Bearer 令牌不匹配。
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。
  • 快速审计基地数量、成员数量和公会所有权。