API kirjeldus

Praegu on saadaval järgmised lõpp-punktid:

Основные типы ответов

Ошибка. Вы получите следующий формат ответа:

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

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

Vastuse kirjeldus:

Väli	Kirjeldus

Väli	Kirjeldus
error.code	HTTP kood
error.message	Vea kirjeldus
error.description	Ilmub ainult olekuga 422. Sisaldab päringus oleva välja nime ja parandamist vajavaid vigu

Värskenda. Saate järgmise vastusevormingu:

{
    "state": false
}

Vastuse kirjeldus:

Väli	Kirjeldus
state	Operatsiooni olek. Võib võtta Boole'i väärtusi. Tagastab ebaõnnestumise korral vale või muul juhul tõese

Lugemine. Saate järgmise vastusevormingu:

Vastuse kirjeldus:

Väli	Kirjeldus

Väli	Kirjeldus
cursor	Kursori tüüpi objekt
collection	Soovitud objektide massiiv

Loomine / Kviitung. Pärast nende toimingute sooritamist saate soovitud/loodud noWrap objekti.