VisiteringOgStatus.SpoergeskemaService (Version 1, 2024-2)

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

GetSelvbetjeningsmulighederForSpoergeskemaResponseDto

1

-    udfyldelseAfSpoergeskemaTilladt

boolean

1

Angiver om borgeren har mulighed for at gennemføre Screeningsløsningen.

-    spoergeskemaAfsluttet

boolean

1

Angiver om der findes et screeningsresultat for den pågældende borger - på tværs af eventuelle ledighedsperioder. ledighedsperiode

-    spoergeskemaAfsluttetTidspunkt

date-time

0 - 1

Angiver dato for gennemført screening.

-    presentationstypeForSpoergeskema

PresentationAfSpoergeskemaTypeCodeList

0 - 1

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

GetFoersteGruppeAfSpoergsmaalResponseDto

1

-    spoergsmaal

SpoergsmaalDtoCollection

1

Spørgsmål

-    -    SpoergsmaalDto

SpoergsmaalDto

0 - *

-    -    -    spoergsmaalIdentifier

uuid

1

Spørgsmålets ID

-    -    -    tekst

string

MinLength: 1

1

Spørgsmålets tekst

-    -    -    type

SpoergsmaalTypeCodeList

1

-    -    -    svarmuligheder

SvarmulighedDtoCollection

1

Svarmuligheder

-    -    -    -    SvarmulighedDto

SvarmulighedDto

0 - *

-    -    -    -    -    svarmulighedIdentifier

uuid

1

Svarmulighedens ID.

-    -    -    -    -    tekst

string

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    type

SvarmulighedTypeCodeList

1

-    -    -    -    -    valgt

boolean

1

Angiver om svarmuligheden er valgt

-    -    -    -    -    overskriftForUddybendeTekst

string

0 - 1

Overskrift for uddybende tekst

-    -    -    -    -    uddybendeTekst

string

0 - 1

Uddybende tekst udfyldt af borger

-    -    -    emne

string

0 - 1

Eventuelt emne som spørgsmålene grupperes inden for

-    nuvaerendeTrin

int32

1

Angiver nuværende trin i spørgeskemaet

-    totaleAntalTrin

int32

1

Angiver det totale antal trin i spørgeskemaet

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

x-requestId [Header]

string

1

Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

requestBody

GetNaesteGruppeAfSpoergsmaalRequestDto

1

-    besvarelser

BesvarelseDtoCollection

1

Afgivne svar på spørgeskema

-    -    BesvarelseDto

BesvarelseDto

0 - *

-    -    -    spoergsmaalIdentifier

uuid

1

ID'et på det spørgsmål som svaret hører til.

-    -    -    valg

ValgDtoCollection

1

Svarmuligheder

-    -    -    -    ValgDto

ValgDto

0 - *

-    -    -    -    -    svarmulighedIdentifier

uuid

1

Svarmulighedens ID.

-    -    -    -    -    uddybendeTekst

string

MaxLength: 1000

0 - 1

Den tekst borgeren har angivet for svarmuligheden. Alle svarmuligheder tillader ikke nødvendigvis tekst.

response

GetNaesteGruppeAfSpoergsmaalResponseDto

1

-    spoergsmaal

SpoergsmaalDtoCollection

1

Spørgsmål

-    -    SpoergsmaalDto

SpoergsmaalDto

0 - *

-    -    -    spoergsmaalIdentifier

uuid

1

Spørgsmålets ID

-    -    -    tekst

string

MinLength: 1

1

Spørgsmålets tekst

-    -    -    type

SpoergsmaalTypeCodeList

1

-    -    -    svarmuligheder

SvarmulighedDtoCollection

1

Svarmuligheder

-    -    -    -    SvarmulighedDto

SvarmulighedDto

0 - *

-    -    -    -    -    svarmulighedIdentifier

uuid

1

Svarmulighedens ID.

-    -    -    -    -    tekst

string

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    type

SvarmulighedTypeCodeList

1

-    -    -    -    -    valgt

boolean

1

Angiver om svarmuligheden er valgt

-    -    -    -    -    overskriftForUddybendeTekst

string

0 - 1

Overskrift for uddybende tekst

-    -    -    -    -    uddybendeTekst

string

0 - 1

Uddybende tekst udfyldt af borger

-    -    -    emne

string

0 - 1

Eventuelt emne som spørgsmålene grupperes inden for

-    faerdigudfyldt

boolean

1

Angiver om spørgeskemaet er færdigudfyldt. Værdien er \'true\', såfremt der ikke er flere spørgsmål tilbage. Muligheder

-    nuvaerendeTrin

int32

1

Angiver nuværende trin i spørgeskemaet. Hvis der ikke er flere spørgsmål sættes værdien til forrige steps værdi + 1

-    totaleAntalTrin

int32

1

Angiver det totale antal trin i spørgeskemaet

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

x-requestId [Header]

string

1

Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

response

uuid

1

A-kasse

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

screeningResultIdentifier [Path]

uuid

1

response

base64Binary

1

A-kasse

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

base64Binary

1

A-kasse

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

screeningResultIdentifier [Path]

uuid

1

response

GetSpoergeskemaresultatResponseDto

1

-    resultatIdentifier

uuid

1

Resultatets ID

-    oprettelsestidspunkt

date-time

1

Angiver det tidspunkt resultatet er dannet.

-    tekst

string

MinLength: 1

1

Den kvitteringstekst borgeren præsenteres for efter færdiggørelse af spørgeskema.

-    besvarelser

ResultatBesvarelseDtoCollection

1

Borgerens besvarelser på spørgeskemaet.

-    -    ResultatBesvarelseDto

ResultatBesvarelseDto

0 - *

-    -    -    tekstForSpoergsmaal

string

Length: 1-500

1

Teksten på det spørgsmål som svaret er knyttet til.

-    -    -    valg

ResultatValgDtoCollection

1

Spørgsmålets svarmuligheder.

-    -    -    -    ResultatValgDto

ResultatValgDto

0 - *

-    -    -    -    -    svarmulighedIdentifier

uuid

1

Svarmulighedens ID.

-    -    -    -    -    tekst

string

MaxLength: 500

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    uddybendeTekst

string

MaxLength: 1000

0 - 1

Den uddybende tekst borgeren har angivet for svarmuligheden. Alle svarmuligheder tillader ikke nødvendigvis tekst.

-    -    -    emneForSpoergsmaal

string

0 - 1

Eventuelt emne som spørgsmålene grupperes inden for

-    maalgruppeForSpoergeskema

MaalgruppeForSpoergeskemaTypeCodeList

1

-    resultatkategori

ResultatkategoriTypeCodeList

0 - 1

-    lokaltSpoergeskemaFindes

boolean

1

Sand såfremt borgerens kommune har en lokal spørgeskemaløsning.

-    lokaltSpoergeskemaLink

string

0 - 1

Link til lokal spørgeskemaløsning.

A-kasse

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

GetSpoergeskemaresultatResponseDto

1

-    resultatIdentifier

uuid

1

Resultatets ID

-    oprettelsestidspunkt

date-time

1

Angiver det tidspunkt resultatet er dannet.

-    tekst

string

MinLength: 1

1

Den kvitteringstekst borgeren præsenteres for efter færdiggørelse af spørgeskema.

-    besvarelser

ResultatBesvarelseDtoCollection

1

Borgerens besvarelser på spørgeskemaet.

-    -    ResultatBesvarelseDto

ResultatBesvarelseDto

0 - *

-    -    -    tekstForSpoergsmaal

string

Length: 1-500

1

Teksten på det spørgsmål som svaret er knyttet til.

-    -    -    valg

ResultatValgDtoCollection

1

Spørgsmålets svarmuligheder.

-    -    -    -    ResultatValgDto

ResultatValgDto

0 - *

-    -    -    -    -    svarmulighedIdentifier

uuid

1

Svarmulighedens ID.

-    -    -    -    -    tekst

string

MaxLength: 500

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    uddybendeTekst

string

MaxLength: 1000

0 - 1

Den uddybende tekst borgeren har angivet for svarmuligheden. Alle svarmuligheder tillader ikke nødvendigvis tekst.

-    -    -    emneForSpoergsmaal

string

0 - 1

Eventuelt emne som spørgsmålene grupperes inden for

-    maalgruppeForSpoergeskema

MaalgruppeForSpoergeskemaTypeCodeList

1

-    resultatkategori

ResultatkategoriTypeCodeList

0 - 1

-    lokaltSpoergeskemaFindes

boolean

1

Sand såfremt borgerens kommune har en lokal spørgeskemaløsning.

-    lokaltSpoergeskemaLink

string

0 - 1

Link til lokal spørgeskemaløsning.

A-kasse

JobCenter

Kommune

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

SpoergeskemaresultaterResponseDto

1

-    spoergeskemaresultater

SpoergeskemaresultatDtoCollection

1

Liste af spørgeskemaresultater.

-    -    SpoergeskemaresultatDto

SpoergeskemaresultatDto

0 - *

-    -    -    resultatIdentifier

uuid

1

Resultatets ID

-    -    -    oprettelsestidspunkt

date-time

1

Angiver det tidspunkt resultatet er dannet.

-    -    -    maalgruppeForSpoergeskema

MaalgruppeForSpoergeskemaTypeCodeList

1

-    -    -    resultatkategori

ResultatkategoriTypeCodeList

0 - 1

JobCenter

Kommune

STAR

x-requestId [Header]

string

1

Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars

requestBody

GemSpoergeskematilmeldingerRequestDto

1

-    jobcenterkode

string

MinLength: 1

1

Identifikation af jobcenter.

-    Spoergeskematilmeldinger

SpoergeskematilmeldingDtoCollection

1

Spørgeskematilmeldinger

-    -    SpoergeskematilmeldingDto

SpoergeskematilmeldingDto

0 - *

-    -    -    maalgruppeForSpoergeskema

MaalgruppeForSpoergeskemaTypeCodeList

1

-    -    -    aktiv

boolean

1

Angiver om spørgeskematilmelding er aktiv

1014

The submitted message is not valid

The submitted message is not valid

4851

Borger må ikke udfylde spørgeskema

Borger må ikke udfylde spørgeskema

4852

Spørgeskemaresultat ikke fundet

Spørgeskemaresultat ikke fundet

4853

Uspecificeret fejl i Spørgeskema

Uspecificeret fejl i Spørgeskema

9421

Et jobcenter må ikke have flere MaalgruppeForSpørgeskemaTypes aktiveret.

Et jobcenter må ikke have flere MaalgruppeForSpørgeskemaTypes aktiveret.

STAR

response

GetAlleSpoergeskematilmeldingerResponseDto

1

-    spoergeskematilmeldingerForJobcenter

SpoergeskematilmeldingForJobcenterDtoCollection

1

Alle spørgeskematilmeldinger for et jobcenter

-    -    SpoergeskematilmeldingForJobcenterDto

SpoergeskematilmeldingForJobcenterDto

0 - *

-    -    -    jobcenterkode

string

MinLength: 1

1

Identifikation af jobcenter.

-    -    -    spoergeskematilmeldinger

SpoergeskematilmeldingDtoCollection

1

Spørgeskematilmeldinger for jobcenter

-    -    -    -    SpoergeskematilmeldingDto

SpoergeskematilmeldingDto

0 - *

-    -    -    -    -    maalgruppeForSpoergeskema

MaalgruppeForSpoergeskemaTypeCodeList

1

-    -    -    -    -    aktiv

boolean

1

Angiver om spørgeskematilmelding er aktiv

1014

The submitted message is not valid

The submitted message is not valid

4851

Borger må ikke udfylde spørgeskema

Borger må ikke udfylde spørgeskema

4852

Spørgeskemaresultat ikke fundet

Spørgeskemaresultat ikke fundet

4853

Uspecificeret fejl i Spørgeskema

Uspecificeret fejl i Spørgeskema

9421

Et jobcenter må ikke have flere MaalgruppeForSpørgeskemaTypes aktiveret.

Et jobcenter må ikke have flere MaalgruppeForSpørgeskemaTypes aktiveret.

A-kasse

JobCenter

Kommune

STAR

jobCenterCode [Path]

string

1

response

GetSpoergeskematilmeldingerResponseDto

1

-    spoergeskematilmeldinger

SpoergeskematilmeldingDtoCollection

1

Sporgeskematilmeldinger

-    -    SpoergeskematilmeldingDto

SpoergeskematilmeldingDto

0 - *

-    -    -    maalgruppeForSpoergeskema

MaalgruppeForSpoergeskemaTypeCodeList

1

-    -    -    aktiv

boolean

1

Angiver om spørgeskematilmelding er aktiv

1014

The submitted message is not valid

The submitted message is not valid

4851

Borger må ikke udfylde spørgeskema

Borger må ikke udfylde spørgeskema

4852

Spørgeskemaresultat ikke fundet

Spørgeskemaresultat ikke fundet

4853

Uspecificeret fejl i Spørgeskema

Uspecificeret fejl i Spørgeskema

9421

Et jobcenter må ikke have flere MaalgruppeForSpørgeskemaTypes aktiveret.

Et jobcenter må ikke have flere MaalgruppeForSpørgeskemaTypes aktiveret.