API aprašymas

Šiuo metu galimi šie galutiniai taškai:

Pagrindiniai atsakymų tipai

Klaida. Gausite tokį atsakymo formatą:

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

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

Atsakymo aprašymas:

Laukas	apibūdinimas

Laukas	apibūdinimas
error.code	HTTP kodas
error.message	Klaidos aprašymas
error.description	Rodoma tik esant būsenai 422. Įtraukiamas prašyme esančio lauko pavadinimas ir klaidos, kurias reikia taisyti

Atnaujinti. Gausite tokį atsakymo formatą:

{
    "state": false
}

Atsakymo aprašymas:

Laukas	apibūdinimas

Laukas	apibūdinimas
state	Veikimo būsena. Gali priimti Būlio reikšmes. Grąžina „false“, jei nepavyko, arba „true“ kitaip

Skaitymas. Gausite tokį atsakymo formatą:

Atsakymo aprašymas:

Laukas	apibūdinimas

Laukas	apibūdinimas
cursor	Įveskite objektą Cursor
collection	Prašomų objektų masyvas

Sukūrimas / gavimas. Atlikę šias operacijas gausite prašomą/sukurtą noWrap objektą.