Required role: | Trivsel | Requires any of the roles: | NovaLink, Forlag, Trivsel, Aula, Skemaprovider, Skemasubscriber, Stamdataprovider, Elevflytning, MueApi |
POST | /trivselsdata/opretTrivselsmaalingTestDefinition | Dette 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 |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DryRun | body | bool? | No | Hvis denne parameter er sat til 'true' bliver valideringen kørt, men data bliver ikke gemt |
Id | body | Guid | Yes | Et id som skal refereres når man indberetter testresultater |
Navn | body | string | Yes | Navnet på testen |
Tidspunkt | body | DateTime | Yes | Afholdelsestidspunkt - den første dato i måneden kan bruges til at angive en given måned |
Spoergsmaal | body | SpoergsmaalDto[] | Yes | De spørgsmål som indgår i testen |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | Yes | Et id som referes i testbesvarelsen |
Nummer | form | int | Yes | Sekvensnummer for spørgsmålet. Det første spørgsmål i testen har nummer 1, det næste nummer 2 osv. |
Tekst | form | string | Yes | Spørgsmålets tekst som vist til eleven |
NationalKategori | form | NationalKategori? | No | Hvis spørgsmålet følger det nationale trivselsformat skal en af de officielle kategorier vælges. |
Kategori | form | string | No | Hvis 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. |
Svarmuligheder | form | SvarmulighedDto[] | Yes | De 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. |
SocialTrivsel |
FagligTrivsel |
RoOgOrden |
StoetteOgInspiration |
Oevrige |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Vaerdi | form | int | Yes | En talværdi der repræsenterer svaret |
Beskrivelse | form | string | Yes | Den tekstværdi som svarmuligheden vises med for eleven |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ValidationErrors | form | TrivselValidationError[] | No | Eventuelle valideringsfejl |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Error | form | string | No | En tekstuel beskrivelse af valideringsfejlen |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
dryRun: False,
id: 00000000000000000000000000000000,
navn: String,
tidspunkt: 0001-01-01,
spoergsmaal:
[
{
id: 00000000000000000000000000000000,
nummer: 0,
tekst: String,
nationalKategori: SocialTrivsel,
kategori: String,
svarmuligheder:
[
{
vaerdi: 0,
beskrivelse: String
}
]
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { validationErrors: [ { error: String } ] }