API-kuvaus

Seuraavat päätepisteet ovat tällä hetkellä saatavilla:

Tärkeimmät vastaustyypit

Virhe. Saat seuraavan vastausmuodon:

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

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

Vastauksen kuvaus:

Ala	Kuvaus

Ala	Kuvaus
error.code	HTTP-koodi
error.message	Virheen kuvaus
error.description	Näkyy vain tilassa 422. Sisältää pyynnön kentän nimen ja korjattavat virheet

Päivittää. Saat seuraavan vastausmuodon:

{
    "state": false
}

Vastauksen kuvaus:

Ala	Kuvaus

Ala	Kuvaus
state	Toiminnan tila. Voi ottaa Boolen arvoja. Palauttaa virheen epätosi tai muuten tosi

Lukeminen. Saat seuraavan vastausmuodon:

Vastauksen kuvaus:

Ala	Kuvaus

Ala	Kuvaus
cursor	Kirjoita objekti Cursor
collection	Joukko pyydettyjä objekteja

Luominen / vastaanotto. Näiden toimintojen suorittamisen jälkeen saat pyydetyn/luodun noWrap-objektin.