GET /banlist

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

Uwierzytelnianie: token Bearer

Wymagane uprawnienie: REST.Banlist.Read

Przeznaczenie

Odczytuje wpisy z listy blokad. Dane blokad są przechowywane w Banlist.json, a nie w Config.json.

Brak.

active: true, false lub 1 do filtrowania według stanu aktywności.
entryType: Filtr według typu wpisu blokady.
userId: Filtr według identyfikatora użytkownika.
ip lub userIP: Filtr według adresu IP.
issuerType, issuerName, issuerIP: Filtr według metadanych wystawcy blokady.
reason: Filtr według tekstu powodu.
q: Ogólne wyszukiwanie tekstowe.

Brak treści żądania.

Pole	Typ	Opis
`Banlist`	obiekt	Dane listy blokad po zastosowaniu filtrów zapytania.

Banlist — schemat obiektu:

Pole	Typ	Opis
`Version`	liczba całkowita	Wersja formatu pliku listy blokad.
`BannedMessage`	ciąg znaków	Komunikat wyświetlany zablokowanym graczom.
`UserEntries`	tablica obiektów	Wpisy blokad użytkowników zgodne z podanymi filtrami.
`IPEntries`	tablica obiektów	Wpisy blokad IP zgodne z podanymi filtrami.

UserEntries[] — schemat elementu:

Pole	Typ	Opis
`UserId`	ciąg znaków	Identyfikator zablokowanego użytkownika.
`Active`	wartość logiczna	Czy blokada jest obecnie aktywna.
`BannedBy`	obiekt	Dane wystawcy blokady.
`UnbannedBy`	obiekt	Dane osoby lub systemu cofającego blokadę, jeśli są dostępne.

IPEntries[] — schemat elementu:

Pole	Typ	Opis
`IP`	ciąg znaków	Zablokowany adres IP.
`Active`	wartość logiczna	Czy blokada jest obecnie aktywna.
`BannedBy`	obiekt	Dane wystawcy blokady.
`UnbannedBy`	obiekt	Dane osoby lub systemu cofającego blokadę, jeśli są dostępne.

Wystawca — schemat obiektu:

Pole	Typ	Opis
`Type`	ciąg znaków	Typ wystawcy, na przykład `rest`, `player` lub `system`.
`NameValue`	ciąg znaków	Nazwa wystawcy, identyfikator użytkownika, token lub zastępczo nazwa typu.
`IP`	ciąg znaków	Metadane adresu IP wystawcy.
`Reason`	ciąg znaków	Powód zapisany dla działania.
`Timestamp`	obiekt	Składowe znacznika czasu UTC działania.

Znacznik czasu — schemat obiektu:

Pole	Typ	Opis
`UTC`	liczba całkowita	Znacznik czasu Unix w sekundach.
`Year`	liczba całkowita	Rok UTC.
`Month`	liczba całkowita	Miesiąc UTC.
`Day`	liczba całkowita	Dzień miesiąca UTC.
`Hour`	liczba całkowita	Godzina UTC.
`Min`	liczba całkowita	Minuta UTC.
`Sec`	liczba całkowita	Sekunda UTC.
`Msec`	liczba całkowita	Składowa milisekund.

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.

GET /v1/pdapi/banlist

GET /v1/pdapi/banlist?active=true&userId=steam_76561198012345678

GET /v1/pdapi/banlist?ip=203.0.113.42