GET /guild/{guild_id}

端点: GET /v1/pdapi/guild/<guild_id>

认证: Bearer 令牌

权限: REST.Guild.Read

用途

返回一个公会及其详细成员和基地/营地信息。

无。

无请求体。

Field	Type	Description
`Guild`	object	Guild details.

Guild object schema:

Field	Type	Description
`name`	string	Guild name.
`Level`	integer	Guild base camp level.
`admin`	object	Guild admin details.
`member_count`	integer	Number of guild members.
`members`	object[]	Detailed guild member records.
`camp_count`	integer	Number of base camps in the guild.
`camps`	object[]	Detailed base camp records.
`items`	object	Guild item storage data.
`expeditions`	object	Guild expedition data.
`laboratory`	object	Guild laboratory research data.

admin object schema:

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

members[] item schema:

camps[] item schema:

Field	Type	Description
`id`	string	Base camp GUID.
`level`	integer	Base camp level.
`world_pos`	object	Base camp world coordinates.
`map_pos`	object	Converted map coordinates.
`state`	string	Current base camp state.
`pals`	object	Base camp worker Pals keyed by Pal instance ID.
`buildings`	string	Current building payload placeholder.

Coordinate object schema:

Camp Pal object schema:

Field	Type	Description
`nickname`	string	Pal nickname.
`pal_id`	string	Pal species identifier.
`npc_id`	string	Unique NPC ID.
`skin_id`	string	Skin ID.
`gender`	string	Pal gender.
`level`	integer	Pal level.
`shiny`	boolean	Whether this is a rare Pal.
`phisical_health`	string	Physical health state as returned by the current API.
`worker_sick`	string	Worker sickness state.
`san`	number	Sanity value.
`imported`	boolean	Whether this is marked as imported.
`friendship`	integer	Friendship point value.
`active_skills`	string[]	Equipped active skills.
`learnt_skills`	string[]	Learned skills.
`passives`	string[]	Passive skill IDs.

items object schema:

Field	Type	Description
`container_id`	string	Guild item container ID, when available.
`current`	integer	Number of occupied slots.
`max`	integer	Total slot count.
`<slot_index>`	object	Slot item object keyed by numeric slot index.

Guild item slot object schema:

Field	Type	Description
`item_id`	string	Item ID in the slot.
`count`	integer	Stack count in the slot.

expeditions object schema:

Field	Type	Description
`finished`	integer	Finished expedition count.
`missions`	object	Released mission flags keyed by mission ID.

laboratory object schema:

Field	Type	Description
`current_research`	string	Current research ID.
`researches`	object	Active research progress keyed by research ID.

Research progress object schema:

Field	Type	Description
`work_amount`	number	Current work amount.
`required_work_amount`	number	Required work amount.
`percentage`	number	Current work divided by required work.

错误响应使用以下格式:

{
    "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 秒内完成。
`404`	`GUILD_NOT_FOUND`	No guild matched the supplied `guild_id`.

GET /v1/pdapi/guild/f0a1c3e9-7d5b-4a28-8c33-411fdc2e6b74

GET /v1/pdapi/guild/92b8f6ac-1a3d-4a9e-8f52-cc741db8c20a