Перейти к содержанию

GET /guilds

Конечная точка: GET /v1/pdapi/guilds

Аутентификация: Токен носителя

Разрешение: REST.Guilds.Read

Цель

Перечисляет известные гильдии со сводной информацией. Используйте эту конечную точку, чтобы узнать идентификаторы гильдий перед запросом конкретной гильдии.

Параметры пути

Нет.

Параметры запроса

Нет.

Тело запроса

Нет тела запроса.

Схема ответа

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.

Реакции на ошибки

Тела ошибок используют следующую форму:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Код ошибки Когда это произойдет
401 INVALID_TOKEN Заголовок Authorization отсутствует, имеет неправильный формат или не соответствует настроенному токену носителя.
403 MISSING_PERMISSION Токен действителен, но не включает это разрешение конечной точки.
400 INVALID_JSON Текст запроса был предоставлен, но его не удалось проанализировать как JSON.
400 REQUEST_FAILED Обратный вызов игрового потока вызвал исключение, или произошел сбой общего преобразователя player/resource.
500 REQUEST_TIMEOUT Обратный вызов внутреннего игрового потока не завершился в течение 5 секунд.

Примеры

Список всех гильдий

GET /v1/pdapi/guilds

Обновить данные панели управления гильдии.

GET /v1/pdapi/guilds

Сценарии

  • Создайте селектор гильдий в админ-панели.
  • Найдите guild_id для GET /guild.
  • Краткий обзор количества баз, количества участников и владения гильдией.