For å begrense antall resultater som returneres fra API-kallene, kan du benytte ulike parametere. Disse parameterne lar deg filtrere dataene basert på spesifikke kriterier, som for eksempel dato, status, eller tilknyttede enheter.
Generelle filtre
De fleste endepunktene i API-et støtter følgende parametere for å filtrere resultater:
-
limit: Begrenser antall resultater som returneres.- Type: Integer
-
Eksempel:
?limit=50
-
offset: Angir startpunktet for resultatene (brukes for paginering).- Type: Integer
-
Eksempel:
?offset=100
-
filter: Tillater mer komplekse søk ved hjelp av spesifikke kriterier.- Type: String (kan variere avhengig av endepunktet)
-
Eksempel:
?filter=status:active
Bruk av "changedSince"
changedSince er en parameter som lar deg hente data som har blitt oppdatert siden en spesifikk dato. Dette er nyttig for å holde dataene dine oppdatert uten å hente hele datasettet hver gang.
-
Parameter:
changedSince -
Format: ISO 8601 (
YYYY-MM-DDTHH:mm:ssZ) -
Eksempel:
- Hente data som har endret seg siden 1. januar 2024, kl. 12:00 UTC:
?changedSince=2024-01-01T12:00:00Z
- Hente data som har endret seg siden 1. januar 2024, kl. 12:00 UTC:
Eksempel på API-kall
Hvis du vil hente en liste over ansatte som har blitt endret siden 1. januar 2024, med et maks antall resultater på 100:
Feilhåndtering
Ved bruk av filtre kan API-et returnere følgende feilkoder:
- 400 Bad Request: Ugyldig parameterverdi eller feil format.
- 401 Unauthorized: Manglende eller ugyldig tilgangsnøkkel.
- 404 Not Found: Ingen resultater ble funnet for de oppgitte parameterne.
Dokumentasjon for spesifikke endepunkter
Hver API-endepunkt har sine egne filtreringsmuligheter som er beskrevet i dokumentasjonen:
API Dokumentasjon
Ta gjerne kontakt dersom du trenger ytterligere hjelp med implementeringen.