Siden opdateres automatisk til at afspejle koden.
Metoder
GetSelvbetjeningsmulighederForSpoergeskema (GET /v1/Spoergeskema/selvbetjeningsmuligheder)
Henter muligheder for selvbetjening for udfyldelse af spørgeskema til brug for Jobnet
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 | |
Fejlkoder
Ingen fejlkoder
GetFoersteGruppeAfSpoergsmaal (GET /v1/Spoergeskema/action/start)
Henter første gruppe af spørgsmål i spørgeskema
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
Fejlkoder
Ingen fejlkoder
GetNaesteGruppeAfSpoergsmaal (POST /v1/Spoergeskema/action/naeste)
Henter næste gruppe af spørgsmål i spørgeskema
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
| 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. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
Fejlkoder
Ingen fejlkoder
AfslutSpoergeskema (POST /v1/Spoergeskema/action/afslut)
Afslut spørgeskema
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
| 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 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | uuid | | 1 | |
Fejlkoder
Ingen fejlkoder
GetSpoergeskemaresultatSomPdf (GET /v1/Spoergeskema/resultat/{screeningResultIdentifier}/pdf)
Hent spørgeskema som pdf
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | | | | | |
| JobCenter | | X | | | X | | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
| screeningResultIdentifier [Path] | uuid | | 0 - 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | base64Binary | | 1 | |
Fejlkoder
Ingen fejlkoder
GetSpoergeskemaresultat (GET /v1/Spoergeskema/resultat/{screeningResultIdentifier})
Hent spørgeskema
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | | | | | |
| JobCenter | | X | | | X | | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
| screeningResultIdentifier [Path] | uuid | | 0 - 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | SpoergeskemaresultatDto | | 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 | |
Fejlkoder
Ingen fejlkoder
GetSpoergeskemaresultat (GET /v1/Spoergeskema/resultater)
Hent spørgeskema
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | | | | | |
| JobCenter | | X | | | X | | | |
| Kommune | | X | | | | | | |
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| civilRegistrationIdentifier [Header] | string | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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. |
| - - - 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 | |
Fejlkoder
Ingen fejlkoder
GemSpoergeskematilmeldinger (POST /v1/Spoergeskema/tilmeldinger)
Denne metode giver mulighed for at ændre oplysninger om, hvorvidt der er valgt spørgeskema for hver af de tre målgrupper (borgere under 30, borgere over 30 eller dagpengemodtagere) for det angivne hovedjobcenter.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| JobCenter | X | | | | X | | | |
| Kommune | X | | | | | | | |
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4385 | The client does not have an unemploymentfund registration | The client does not have an unemploymentfund registration |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
| 9421 | | |
GetAlleSpoergeskematilmeldinger (GET /v1/Spoergeskema/tilmeldinger)
Denne metode giver mulighed for at hente en liste over alle hovedjobcentre med oplysninger om, hvorvidt der er valgt profilafklaring for hver af de tre målgrupper (borgere under 30, borgere over 30 eller dagpengemodtagere). Metoden anvendes af Landssupportsystemet, hvor der gives et overblik, og oplysningerne kan ændres.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4385 | The client does not have an unemploymentfund registration | The client does not have an unemploymentfund registration |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |
GetSpoergeskematilmeldinger (GET /v1/Spoergeskema/tilmeldinger/{jobCenterCode})
Denne metode giver mulighed for at hente oplysninger om, hvorvidt der er valgt profilafklaring for hver af de tre målgrupper (borgere under 30, borgere over 30 eller dagpengemodtagere) for det angivne hovedjobcenter.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|
| A-kasse | X | | | | | | | |
| JobCenter | X | | | | X | X | | |
| Kommune | X | | | | | | | |
| STAR | X | | | | | | | |
Scope
visiteringogstatus.spoergeskema.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| jobCenterCode [Path] | string | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetSpoergeskematilmeldingerResponseDto | | 1 | |
| - spoergeskematilmeldinger | SpoergeskematilmeldingDtoCollection | | 1 | Sporgeskematilmeldinger |
| - - SpoergeskematilmeldingDto | SpoergeskematilmeldingDto | | 0 - * | |
| - - - maalgruppeForSpoergeskema | MaalgruppeForSpoergeskemaTypeCodeList | | 1 | |
| - - - aktiv | boolean | | 1 | Angiver om spørgeskematilmelding er aktiv |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 1014 | The submitted message is not valid | The submitted message is not valid |
| 4385 | The client does not have an unemploymentfund registration | The client does not have an unemploymentfund registration |
| 4575 | You are not authorized to execute the operation | You are not authorized to execute the operation |