Pular para conteúdo

GET /guild/{guild_id}

Ponto final: GET /v1/pdapi/guild/<guild_id>

Autenticação: Token do portador

Permissão: REST.Guild.Read

Objetivo

Retorna uma guilda com informações detalhadas sobre membros e base/camp.

Parâmetros de caminho

  • guild_id: Identificador da guilda, geralmente copiado de GET /guilds.

Parâmetros de consulta

Nenhum.

Solicitar corpo

Nenhum corpo de solicitação.

Esquema de resposta

200 response schema

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:

Field Type Description
player_uid string Member PlayerUID.
player_name string Member player name.
status string Member status.

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:

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

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.

Respostas de erro

Os corpos de erro usam esta forma:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Código de erro Quando isso acontece
401 INVALID_TOKEN O cabeçalho Authorization está ausente, malformado ou não corresponde a um token de portador configurado.
403 MISSING_PERMISSION O token é válido, mas não inclui essa permissão de endpoint.
400 INVALID_JSON Um corpo de solicitação foi fornecido, mas não pôde ser analisado como JSON.
400 REQUEST_FAILED O retorno de chamada do thread do jogo gerou uma exceção ou um resolvedor player/resource compartilhado falhou.
500 REQUEST_TIMEOUT O retorno de chamada do thread de jogo interno não foi concluído em 5 segundos.
404 GUILD_NOT_FOUND Nenhuma guilda correspondeu ao guild_id fornecido.

Exemplos

Leia a lista de guildas e acampamentos

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

Leia outra guilda por GUID

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

Cenários

  • Investigue a propriedade da base antes de excluí-la.
  • Revise os membros da guilda e os dados do acampamento para solicitações de suporte.
  • Use cuidadosamente os IDs de acampamento da resposta com POST /deletebase.