GET /players

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

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

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

Цель

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

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

Нет.

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

Нет.

Тело запроса

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

Схема ответа

200 response schema

Field	Type	Description
`Meta`	object	Player list counts.
`Players`	object[]	Known players with identifying, guild, status, and location information.

Meta object schema:

Field	Type	Description
`PlayerCount`	integer	Number of player accounts returned.
`OnlineCount`	integer	Number of returned players currently online.

Players[] item schema:

Field	Type	Description
`Name`	string	Current or saved player name.
`IP`	string	Player IP address, or an empty string when unavailable.
`PlayerUID`	string	Player UID used by Palworld save data.
`UserId`	string	Platform user ID, or an empty string when unavailable.
`GuildName`	string	Guild name, or an empty string when unavailable.
`GuildUUID`	string	Guild UUID, or a zero GUID when unavailable.
`Status`	string	Saved player account state.
`WorldLocation`	object	Current or last saved world coordinates.
`MapLocation`	object	Converted map coordinates.

Location 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 секунд.
`500`	`PLAYER_MANAGER_UNAVAILABLE`	Серверу не удалось получить доступ к менеджеру проигрывателя Palworld.

Примеры

Список всех известных игроков

GET /v1/pdapi/players

Обновить селектор игрока администратора.

GET /v1/pdapi/players

Сценарии

Создайте раскрывающийся список онлайн-и известных игроков.
Найдите правильный UserId или PlayerUID перед вызовом конечных точек вознаграждения, наказания или инвентаря.
Проверяйте, кто находится в сети, прежде чем отправлять сообщение или предупреждение о плановом обслуживании.