Opis API

Obecnie dostępne są następujące punkty końcowe:

Główne rodzaje odpowiedzi

Błąd. Otrzymasz odpowiedź w następującym formacie:

{
    "error": {
        "code": 404,
        "message": "Not found"
    }
}

{
    "error": {
        "code": 422,
        "description": {
            "limitation": [
                "Limitation for page is missing"
            ],
            "page": [
                "Page is missing"
            ]
        },
        "message": "Unprocessable entity"
    }
}

Opis odpowiedzi:

Pole	Opis

Pole	Opis
error.message	Opis błędu
error.description	Pojawia się wyłącznie przy statusie 422. Zawiera nazwę pola w zapytaniu oraz błędy, które należy poprawić
error.code	HTTP code

Aktualizacja. Otrzymasz odpowiedź w następującym formacie:

{
    "state": false
}

Opis odpowiedzi:

Pole	Opis

Pole	Opis
state	Status operacji. Może przyjmować wartości Boolean. Zwraca wartość false, jeśli wykonanie nie powiedzie się, lub true w przeciwnym wypadku

Czytanie. Otrzymasz odpowiedź w następującym formacie:

Opis odpowiedzi:

Pole	Opis

Pole	Opis
cursor	Typ obiektu Cursor
collection	Tablica żądanych obiektów

Utwórz / Odzyskaj. Po wykonaniu tych operacji użytkownik otrzyma żądany/utworzony obiekt noWrap.