Grunderna i API

Ändrad den Mån, 9 juni vid 3:55 E.M.

Paginering

Alla GET-slutpunkter har stöd för paginering och sortering. Pagineringen är markörbaserad och parametrarna är first (heltal) och after (sträng). Om inga resultat anges returnerar API:et ett förinställt antal resultat från början med användning av en förvalt sortering. Förvalt antal resultat varierar beroende på operation.

Ett exempel på användning av paginering

Auktoriseringsrubriken har tagits bort för att göra det enkelt och svaren har förenklats.

GET /år

Returnerar ett svar som ser ut ungefär så här:

{
    "totalCount": 4,
    "pageInfo": {
        "hasNextPage": true,
        "startCursor": "aWR4OzA=",
        "endCursor": "aWR4OzE="
    },
    "items": [
        {
            "cursor": "aWR4OzA=",
            "node": {
                "name": "2017"
            }
        },
        {
            "cursor": "aWR4OzE=",
            "node": {
                "name": "2018"
            }
        }
    ]
}

Alla svar har samma struktur för att underlätta paginering.

Fastighet	Beskrivning
totalantal	Det totala antalet resurser
pageInfo.hasNextPage	Sant om det finns fler sidor
pageInfo.startCursor	Sidans startmarkör
pageInfo.endCursor	Sidans slutmarkör
föremål	Array med returnerade artiklar
objekt.markör	Objektets markör
artikel.nod	Den faktiska resursen för objektet

Eftersom pageInfo.hasNextPage är sant vet vi att det finns mer data att samla in. Den här gången använder vi parametern after för att ange att vi vill börja på en viss position.

GET /years?first=2&after=aWR4OzE=

Returnerar ett svar som detta

{
"totalCount": 4,
"pageInfo": {
"hasNextPage": false,
"startCursor": "aWR4OzI=",
"endCursor": "aWR4OzM="
},
"items": [
{
"cursor": "aWR4OzI=",
"node": {
"name": "2019"
}
},
{
"cursor": "aWR4OzM=",
"node": {
"name": "2020"
}
}
]
}

PageInfo.hasNextPage är false så vi har inga fler data att hämta.

Svar på fel

Om begäran är ogiltig kommer API:et att svara med statuskod 400 och ett felsvar. Felsvaret innehåller en felegenskap som är en array med felbeskrivningar.

Egendom	Beskrivning
egendom	Namn på den egenskap som felet gäller
felmeddelande	Felmeddelandet, vad är fel
förslag	Vad bör ändras?

Exempel på ett felsvar vid användning av 510 som värde för en första parameter.

{
    "fel": [
        {
            "property": "first",
            "errorMessage": "510 invalid value",
            "suggestion": "Måste vara mellan 1 och 100"
        }
    ]
}