TominDeveloper

Typer og validering

API'et gemmer kun indhold, der har præcis den type og størrelse, som dokumentationen beskriver. Alt andet afvises, og intet bliver gemt.

Indhold er JSON

Send indholdet som et JSON-objekt med headeren Content-Type: application/json. Andet indhold giver 415 unsupported_media_type, og JSON der ikke kan læses giver 400 invalid_json. Den eneste undtagelse er Upload bilag, som tager en fil som multipart/form-data. Værdier i adressen tæller aldrig som indhold.

Typer

string
Tekst i anførselstegn. Uden linjeskift, når der ikke står andet.
int
Et helt tal uden anførselstegn og uden decimaler, for eksempel 14.
decimal
Et tal uden anførselstegn med punktum som decimaltegn, for eksempel 1250.5.
bool
true eller false uden anførselstegn.
date
En dato som tekst, for eksempel 2026-11-03.
datetime
Et tidspunkt i UTC som tekst, for eksempel 2026-10-03T07:12:00Z.
list
En JSON-liste i kantede parenteser. Et objekt tæller ikke som en liste.
object
Et JSON-objekt med egne felter. Findes kun i svar.

Typen skal passe præcist. Et tal i anførselstegn er en tekst, så "12" afvises i et felt af typen int, og 8000 afvises i et felt af typen string. Står der | null efter typen i et svar, kan feltet være tomt.

Det står der ved hvert felt

påkrævet
Feltet skal sendes og må ikke være tomt.
valgfri
Feltet kan udelades. Har det en standardværdi, bruges den.
Længde
Hvor mange tegn en tekst må have.
Interval
Det mindste og det største tal.
Decimaler
Hvor mange decimaler et tal må have.
Værdier
De eneste værdier, feltet tager.
Standard
Værdien feltet får, når du ikke sender det.

Tomme værdier og standardværdier

Et felt du ikke sender, null og en tom tekst betyder det samme. Feltet får sin standardværdi, hvis det har en, og bliver ellers tomt. Mellemrum før og efter en tekst fjernes.

Ukendte felter

Et felt, som endpointet ikke kender, afvises, så en stavefejl aldrig bliver ignoreret. Felterne id, self, created_at og updated_at springes over, så du kan sende et hentet objekt tilbage. En gruppe og en enhed sendes som group_id og unit_id.

Når noget afvises

Svaret er 422 validation_failed, og details har en besked for hvert felt, der er forkert. Rediger du med PUT, er intet ændret, før alle felter er gyldige.