MinUddannelse Api

<back to all web services

OpretTrivselsmaalingTestDefinitionRequest

Requires Authentication
Required role:TrivselRequires any of the roles:NovaLink, Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi
The following routes are available for this service:
POST/trivselsdata/opretTrivselsmaalingTestDefinitionDette API bruges til at oprette testdefinitioner. Disse skal oprettes før tests der bruger definitionen kan indrapporteres.Klienten angiver et id for hver testdefinition, som efterfølgende skal bruges når testdata indrapporteres.Det er op til klienten at holde styr på de id'er de har brugt
OpretTrivselsmaalingTestDefinitionRequest Parameters:
NameParameterData TypeRequiredDescription
DryRunbodybool?NoHvis denne parameter er sat til 'true' bliver valideringen kørt, men data bliver ikke gemt
IdbodyGuidYesEt id som skal refereres når man indberetter testresultater
NavnbodystringYesNavnet på testen
TidspunktbodyDateTimeYesAfholdelsestidspunkt - den første dato i måneden kan bruges til at angive en given måned
SpoergsmaalbodySpoergsmaalDto[]YesDe spørgsmål som indgår i testen
SpoergsmaalDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidYesEt id som referes i testbesvarelsen
NummerformintYesSekvensnummer for spørgsmålet. Det første spørgsmål i testen har nummer 1, det næste nummer 2 osv.
TekstformstringYesSpørgsmålets tekst som vist til eleven
NationalKategoriformNationalKategori?NoHvis spørgsmålet følger det nationale trivselsformat skal en af de officielle kategorier vælges.
KategoriformstringNoHvis spørgsmålet tilhører en egendefineret kategori kan den beskrives ved navn. Hvis ét spørgsmål i en test har en kategori skal alle have det - enten en national eller en egendefineret kategori.
SvarmulighederformSvarmulighedDto[]YesDe svarmuligheder som elev bliver præsentareret for til dette spørgsmål. Svarmulighederne skal komme i den rækkefølge som de blev vist for eleven.
NationalKategori Enum:
SocialTrivsel
FagligTrivsel
RoOgOrden
StoetteOgInspiration
Oevrige
SvarmulighedDto Parameters:
NameParameterData TypeRequiredDescription
VaerdiformintYesEn talværdi der repræsenterer svaret
BeskrivelseformstringYesDen tekstværdi som svarmuligheden vises med for eleven
TrivselValidationResponse Parameters:
NameParameterData TypeRequiredDescription
ValidationErrorsformTrivselValidationError[]NoEventuelle valideringsfejl
TrivselValidationError Parameters:
NameParameterData TypeRequiredDescription
ErrorformstringNoEn tekstuel beskrivelse af valideringsfejlen

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /trivselsdata/opretTrivselsmaalingTestDefinition HTTP/1.1 
Host: api.minuddannelse.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"dryRun":false,"id":"00000000000000000000000000000000","navn":"String","tidspunkt":"\/Date(-62135596800000-0000)\/","spoergsmaal":[{"id":"00000000000000000000000000000000","nummer":0,"tekst":"String","nationalKategori":"SocialTrivsel","kategori":"String","svarmuligheder":[{"vaerdi":0,"beskrivelse":"String"}]}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"validationErrors":[{"error":"String"}]}