GET /guilds

Point final : GET /v1/pdapi/guilds

Auth : Jeton du porteur

Autorisation : REST.Guilds.Read

Objectif

Répertorie les guildes connues avec des informations récapitulatives. Utilisez ce point de terminaison pour découvrir les identifiants de guilde avant de demander une guilde spécifique.

Paramètres du chemin

Aucun.

Paramètres de requête

Aucun.

Corps de la demande

Aucun corps de requête.

Schéma de réponse

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.

Réponses aux erreurs

Les corps d'erreur utilisent cette forme :

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}

HTTP	Code d'erreur	Quand ça arrive
`401`	`INVALID_TOKEN`	L'en-tête `Authorization` est manquant, mal formé ou ne correspond pas à un jeton de support configuré.
`403`	`MISSING_PERMISSION`	Le jeton est valide, mais il n'inclut pas cette autorisation de point de terminaison.
`400`	`INVALID_JSON`	Un corps de requête a été fourni, mais il n'a pas pu être analysé comme JSON.
`400`	`REQUEST_FAILED`	Le rappel du thread de jeu a généré une exception ou un résolveur player/resource partagé a échoué.
`500`	`REQUEST_TIMEOUT`	Le rappel du thread de jeu interne ne s'est pas terminé dans les 5 secondes.

Exemples

Lister toutes les guildes

GET /v1/pdapi/guilds

Actualiser les données du tableau de bord de guilde

GET /v1/pdapi/guilds

Scénarios

Créez un sélecteur de guilde dans un panneau d'administration.
Recherchez le guild_id pour GET /guild.
Auditez le nombre de bases, le nombre de membres et la propriété de la guilde en un coup d'œil.