GET /guilds

Punkt końcowy: GET /v1/pdapi/guilds

Uwierzytelnianie: token Bearer

Wymagane uprawnienie: REST.Guilds.Read

Przeznaczenie

Wyświetla znane gildie z podstawowymi informacjami. Użyj tego punktu końcowego, aby poznać identyfikatory przed pobraniem danych konkretnej gildii.

Brak.

Brak.

Brak treści żądania.

Pole	Typ	Opis
`Meta`	obiekt	Metadane listy gildii.
`Guilds`	obiekt	Podsumowania znanych gildii według UUID gildii.

Meta — schemat obiektu:

Pole	Typ	Opis
`GuildCount`	liczba całkowita	Liczba zwróconych gildii.

Podsumowanie gildii — schemat obiektu:

Pole	Typ	Opis
`name`	ciąg znaków	Nazwa gildii.
`Level`	liczba całkowita	Poziom obozu bazowego gildii.
`admin`	obiekt	Dane administratora gildii.
`camp_count`	liczba całkowita	Liczba obozów bazowych gildii.
`camps`	tablica obiektów	Podsumowania obozów bazowych.
`member_count`	liczba całkowita	Liczba członków gildii.
`members`	tablica ciągów znaków	Wartości PlayerUID członków gildii.

admin — schemat obiektu:

Pole	Typ	Opis
`id`	ciąg znaków	PlayerUID administratora.
`name`	ciąg znaków	Nazwa gracza będącego administratorem.

camps[] — schemat elementu:

Pole	Typ	Opis
`id`	ciąg znaków	GUID obozu bazowego.
`world_pos`	obiekt	Współrzędne obozu bazowego w świecie.
`map_pos`	obiekt	Przeliczone współrzędne mapy.

Współrzędne — schemat obiektu:

Treść odpowiedzi błędu ma następującą postać:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Czytelny opis błędu",
        "Details": {}
    }
}

HTTP	Kod błędu	Kiedy występuje
`401`	`INVALID_TOKEN`	Brakuje nagłówka `Authorization`, ma on nieprawidłowy format lub nie odpowiada żadnemu skonfigurowanemu tokenowi Bearer.
`403`	`MISSING_PERMISSION`	Token jest prawidłowy, ale nie ma uprawnienia wymaganego przez ten punkt końcowy.
`400`	`INVALID_JSON`	Przesłano treść żądania, ale nie można jej odczytać jako JSON.
`400`	`REQUEST_FAILED`	Funkcja wywołana w wątku gry zgłosiła wyjątek lub wspólny mechanizm wyszukiwania gracza/zasobu zakończył się niepowodzeniem.
`500`	`REQUEST_TIMEOUT`	Wewnętrzna funkcja wywołana w wątku gry nie zakończyła się w ciągu 5 sekund.

GET /v1/pdapi/guilds

GET /v1/pdapi/guilds