Zum Inhalt

GET /guilds

Endpunkt: GET /v1/pdapi/guilds

Auth: Bearer-Token

Berechtigung: REST.Guilds.Read

Zweck

Listet bekannte Gilden mit Zusammenfassung auf. Nutze diesen Endpunkt, um Gilden-IDs zu finden, bevor du eine bestimmte Gilde abfragst.

Pfadparameter

Keine.

Query-Parameter

Keine.

Request-Body

Kein Request-Body.

Antwortschema

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.

Fehlerantworten

Fehlerantworten verwenden dieses Format:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Für Menschen lesbare Nachricht",
        "Details": {}
    }
}
HTTP Fehlercode Wann es passiert
401 INVALID_TOKEN Der Authorization-Header fehlt, ist fehlerhaft oder passt zu keinem konfigurierten Bearer-Token.
403 MISSING_PERMISSION Das Token ist gültig, enthält aber nicht die Berechtigung für diesen Endpunkt.
400 INVALID_JSON Ein Request-Body wurde gesendet, konnte aber nicht als JSON gelesen werden.
400 REQUEST_FAILED Der Game-Thread-Callback hat eine Ausnahme ausgelöst oder ein gemeinsamer Spieler-/Ressourcen-Resolver ist fehlgeschlagen.
500 REQUEST_TIMEOUT Der interne Game-Thread-Callback wurde nicht innerhalb von 5 Sekunden abgeschlossen.

Beispiele

List all guilds

GET /v1/pdapi/guilds

Refresh guild dashboard data

GET /v1/pdapi/guilds

Szenarien

  • 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.