Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Siden opdateres automatisk til at afspejle koden. CodeFirst.af FA

Metoder

Table of Contents
maxLevel2

GetSpoergeskema (GET /v1/Spoergeskema/Spoergsmaal/FoesteGruppe)

(Gl. DFDG CitizenScreeningService (Version 1, 2021-1).GetFirstGroupOfQuestions)

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getfoersteGruppeAfSporgsmaalRequest

(GetFirstGroupOfQuestionsRequest)

GetfoersteGruppeAfSporgsmaalDto

 

1

 

- x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

getfoersteGruppeAfSporgsmaalResponse

(GetFirstGroupOfQuestionsResponse)

GetfoersteGruppeAfSporgsmaalResponseDto

 

1

 

- alleSpoergsmaal

(Questions)

AlleSpoergsmaalDto

 

1

Alle spørgsmål 

-    - spoergsmaal

(QuestionType)

SpoergsmaalDto

 

0 - *

 Spørgsmål

-    -    - spoergsmaalsIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Spørgsmålets ID

-    -    - tekst

(Text)

string

 

1

Spørgsmålets tekst

-    -    - spoergsmaalsKategori

(Category)

VisiteringOgStatus.SpoergsmaalsKategoriCodeList

Erstatter Enumeration:

  • SingleChoice

  • MultipleChoice

1

Angiver typen af spørgsmål

-    -    - svarmuligheder

(Options)

SvarmulighederDto

 

1

 Svarmuligheder

-    -    -    - svarmulighed

(QuestionOptionType)

SvarmulighedDto

 

0 - *

 Svarmulighed

-    -    -    -    - svarmulighedIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarmulighedens ID.

-    -    -    -    - tekst

(Text)

string

 

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    - svarmulighedskategori

(Category)

VisiteringOgStatus.SvarmulighedstypeCodeList

Erstatter

Enumeration:

  • Default

  • AllowAdditionalText

  • DisplayAsHeader

1

Typen af svarmulighed. Default: Almindelig. AllowAdditionalText: Mulighed for at skrive supplerende tekst. DisplayAsHeader: Benyt som underoverskrift. (kan ikke vælges af brugeren)

-    -    -    -    - valgt

(Selected)

boolean

 

1

Angiver om svarmuligheden er valgt af borgeren.

-    -    -    -    - ekstraTekstTop

(AdditionalTextHeader)

string

 

0 - 1

 

-    -    -    -    - ekstraTekst

(AdditionalText)

string

 

0 - 1

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

-    -    - emne

(Topic)

string

 

1

Eventuelt emne som spørgsmålene grupperes inden for

- nuvaerendeTrin

(CurrentSurveyStep)

int

 

1

Angiver nuværende trin i spørgeskemaet

- totaleAntalTrin

(TotalSurveySteps)

int

 

1

Angiver det totale antal trin i spørgeskemaet

Fejlkoder

Ingen fejlkoder

CreateSpoergeskema (POST /v1/Spoergeskema/Spoergsmaal/NaesteGruppe)

(Gl. DFDG CitizenScreeningService (Version 1, 2021-1).GetNextGroupOfQuestions)

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getnaesteGruppeAfSporgsmaalRequest

(GetNextGroupOfQuestionsRequest)

GetnaesteGruppeAfSporgsmaalRequestDto

 

1

 

- x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

- alleSvar

(Answers)

AlleSvarDto

 

1

 Alle Svar

-    - svar

(AnswerType)

SvarDto

 

0 - *

 Svar

-    -    - svarIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarets ID.

-    -    - spoergsmaalsIdentifier

(QuestionId)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

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

-    -    - svarmuligheder

(Choices)

SvarmulighederDto

 

1

Svarmuligheder  Spørgsmålets svarmuligheder.

-    -    -    - svarmulighed

(AnswerChoiceType)

SvarmulighedDto

 

0 - *

Svarmulighed

-    -    -    -    - svarmulighedIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarmulighedens ID.

-    -    -    -    - ekstraTekst

(AdditionalText)

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

getnaesteGruppeAfSporgsmaalResponse

(GetNextGroupOfQuestionsResponse)

GetnaesteGruppeAfSporgsmaalResponseDto

 

1

 

- alleSpoergsmaal

(Questions)

AlleSpoergsmaalDto

 

1

 Alle spørgsmål

-    - spoergsmaal

(QuestionType)

SpoergsmaalDto

 

0 - *

Spoergsmål

-    -    - spoergsmaalsIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Spørgsmålets ID

-    -    - tekst

(Text)

string

 

1

Spørgsmålets tekst

-    -    - spoergsmaalsKategori

(Category)

VisiteringOgStatus.SpoergsmaalsKategoriCodeList

Erstatter Enumeration:

  • SingleChoice

  • MultipleChoice

1

Angiver typen af spørgsmål

-    -    - svarmuligheder

(Options)

SvarmulighederDto

 

1

 Svarmuligheder

-    -    -    - svarmulighed (QuestionOptionType)

SvarmulighedDto

 

0 - *

 Svarmulighed

-    -    -    -    - svarmulighedIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarmulighedens ID.

-    -    -    -    - tekst

(Text)

string

 

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    - svarmulighedskategori (Category)

VisiteringOgStatus.SvarmulighedstypeCodeList

Erstatter

Enumeration:

  • Default

  • AllowAdditionalText

  • DisplayAsHeader

1

Typen af svarmulighed. Default: Almindelig. AllowAdditionalText: Mulighed for at skrive supplerende tekst. DisplayAsHeader: Benyt som underoverskrift. (kan ikke vælges af brugeren)

-    -    -    -    - valgt

(Selected)

boolean

 

1

Angiver om svarmuligheden er valgt af borgeren.

-    -    -    -    - ekstraTekstTop (AdditionalTextHeader)

string

 

0 - 1

 

-    -    -    -    - ekstraTekst

(AdditionalText)

string

 

0 - 1

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

-    -    - emne

(Topic)

string

 

1

Eventuelt emne som spørgsmålene grupperes inden for

- faerdigudfyldt

(SurveyCompleted)

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

(CurrentSurveyStep)

int

 

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

(TotalSurveySteps)

int

 

1

Angiver det totale antal trin i spørgeskemaet

Fejlkoder

Ingen fejlkoder

SubmitAndPerformScreening

Tilladte organisationer

AfslutSpoergeskema (POST /v1/Spoergeskema/Spoergsmaal/Afslut)

(Gl. DFDG CitizenScreeningService (Version 1, 2021-1).SubmitAndPerformScreening)

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

IndsendOgGennemfoerSpoergeskemaRequest

(SubmitAndPerformScreeningRequest)

SubmitAndPerformScreeningRequestType

 

1

 

- x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Tom

SubmitAndPerformScreeningResponse

SubmitAndPerformScreeningResponseType

 

1

 

  • MessageIdentifier

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

 

Fejlkoder

Ingen fejlkoder

...

GetSpoergeskemaresultat (GET /v1/Spoergeskema/Resultat/Pdf)

(Gl. DFDG GetScreeningResultAsPdf)

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

A-kasse

X

 

JobCenter

 

X

 

X

 

Kommune

 

X

 

STAR

 

X

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResultatSomPdfRequest

GetScreeningResultRequest

GetScreeningResultAsPdfRequest

GetScreeningResultRequestType

GetSpoergeskemaResultatSomPdfRequestDto

 

1

 

- x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResultatSomPdfResponse

GetScreeningResultResponse

GetScreeningResultAsPdfResponse

GetScreeningResultResponseType

GetSpoergeskemaResultatSomPdfResponseDto

 

1

 

CreatedDate

- Data

dateTime

base64Binary

 

1

Angiver det tidspunkt screeningsresultatet er dannet

Spørgeskema resultat som Pdf.

- tekst

(Text)

string

 

1

Den tekst borgeren præsenteres for efter endt screening.

  • SurveyAnswers

ResultAnswerTypeCollection

 

1

Borgerens besvarelser på spørgeskemaet.

  • -    ResultAnswerType

ResultAnswerType

 

0 - *

 

-    -    - svarIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarets ID

  • -    -    QuestionText

string

 

1

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

  • -    -    Choices

ResultAnswerChoiceTypeCollection

 

1

 

  • -    -    -    ResultAnswerChoiceType

ResultAnswerChoiceType

 

0 - *

 

-    -    -    -    - svarmulighedIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarmulighedens ID.

-    -    -    -    - tekst

(Text)

string

 

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    - valgt

(Selected)

boolean

 

1

Angiver om svarmuligheden er valgt af borgeren.

-    -    -    -    - ekstraTekstTop (AdditionalTextHeader)

string

 

0 - 1

 

-    -    -    -    - ekstraTekst

(AdditionalText)

string

 

1

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

-    -    - emne

(QuestionTopic)

string

 

0 - 1

Eventuelt emne som spørgsmålene grupperes inden for

  • BackgroundVariables

BackgroundVariableTypeCollection

 

1

De variabler der ligger til grund for screeningen.

  • -    BackgroundVariableType

BackgroundVariableType

 

0 - *

 

  • -    -    Name

string

 

1

Parameterens navn.

  • -    -    DisplayName

string

 

1

Parameterens viste navn.

  • -    -    Value

string

 

1

Parameterens værdi.

  • LocalScreeningExists

boolean

 

1

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

  • LocalScreeningLink

string

 

1

Link til lokal screeningsløsning.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

4852

Screening result not found

Screening result not found

GetScreeningResultAsPdf

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultAsPdfRequest

GetScreeningResultAsPdfRequestType

 

1

 

- x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultAsPdfResponse

GetScreeningResultAsPdfResponseType

 

1

 

  • Data

base64Binary

 

1

Screening Result som Pdf.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

4852

Screening result not found

Screening result not found

ScreeningResultExists

Denne metode giver mulighed for at se, om der foreligger et profilafklaringsresultat for en given borger.

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

...

Kommune

...

X

...

STAR

...

X

Scope

Ikke defineret

Input

...

Element

...

Type

...

Detaljer

...

Forekomst

...

Beskrivelse

...

ScreeningResultExistsRequest

...

ScreeningResultExistsRequestType

...

1

...

-    x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

...

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

...

Borgers personnummer.

Output

...

Element

...

Type

...

Detaljer

...

Forekomst

...

Beskrivelse

...

ScreeningResultExistsResponse

...

ScreeningResultExistsResponseType

...

1

...

-    Exists

...

boolean

...

1

...

Angiver om der findes et screeningsresultat for den pågældende borger, uanset resultatets alder. foretaget.

...

-    CreatedDate

...

dateTime

...

0 - 1

...

Angiver det tidspunkt screeningsresultatet er dannet.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

GetScreeningResult

Denne metode giver mulighed for at hente seneste profilafklaringsresultat for en given borger.

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

...

Kommune

...

X

...

STAR

...

X

Scope

Ikke defineret

Input

...

Element

...

Type

...

Detaljer

...

Forekomst

...

Beskrivelse

...

GetScreeningResultRequest

...

GetScreeningResultRequestType

...

1

...

-    x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

...

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

...

Borgers personnummer.

...

-    ScreeningResultIdentifier

...

guid
Base: string

...

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

...

0 - 1

...

Screeningsresultatets ID

Output

...

Element

...

Type

...

Detaljer

...

Forekomst

...

Beskrivelse

...

GetScreeningResultResponse

...

GetScreeningResultResponseType

...

1

...

-    ScreeningResultIdentifier

...

guid
Base: string

...

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

...

1

...

Screeningsresultatets ID

...

-    CreatedDate

...

dateTime

...

1

...

Angiver det tidspunkt screeningsresultatet er dannet.

...

-    tekst

(Text)

...

string

...

1

...

Den kvitteringstekst borgeren præsenteres for efter endt screening.

...

-    SurveyAnswers

...

ResultAnswerTypeCollection

...

1

...

Borgerens besvarelser på spørgeskemaet.

...

-    -    ResultAnswerType

...

ResultAnswerType

...

0 - *

-    -    -    svarIdentifier

...

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

4852

Spørgeskema resultate ikke fundet

Screening result not found

Spørgeskema resultate ikke fundet

Screening result not found

GetSpoergeskemaresultatFindes (GET /v1/Spoergeskema/Resultat/Findes)

(Gl. DFDH ScreeningResultExists )

Denne metode giver mulighed for at se, om der foreligger et spørgeskemaresultat for en given borger.

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

Kommune

X

STAR

X

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getEksisterSpoergeskemaRequest

ScreeningResultExistsRequest

GetEksisterSpoergeskemaRequestDto

1

-    x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

getEksisterSpoergeskemaResponse

ScreeningResultExistsResponse

GetEksisterSpoergeskemaResponseDto

1

-    resultatFindes

(Exists)

boolean

1

Angiver om der findes et spørgeskemaresultat for den pågældende borger, uanset resultatets alder. foretaget.

-    oprettelsestidspunkt

(CreatedDate)

dateTime

0 - 1

Angiver det tidspunkt spørgeskemaresultatet er dannet.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

GetSpoergeskemaresultat (GET /v1/Spoergeskema/Resultat)

(GL. DFDG GetScreeningResult)

Denne metode giver mulighed for at hente seneste spørgeskemaresultat for en given borger.

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

Kommune

X

STAR

X

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResultatRequest

GetScreeningResultRequest

GetSpoergeskemaResultatRequestDto

1

-    x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

-    resultatIdentifier

(ScreeningResultIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

0 - 1

Svarets ID.

-    -    -    QuestionText

string

MaxLength: 500

1

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

-    -    -    Choices

ResultAnswerChoiceTypeCollection

1

Sp??rgsm??lets svarmuligheder.

-    -    -    -    ResultAnswerChoiceType

ResultAnswerChoiceType

0 - *

-    -    -    -    -    svarmulighedIdentifier

(Id

Id på Spørgeskemaets resultatet

Output

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultAsPdfResponse

GetScreeningResultAsPdfResponseType

1

-    Data

base64Binary

1Parameterens viste navn    Value 200

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResultatResponse

GetScreeningResultResponse

GetSpoergeskemaResultatResponseDto

1

-    resultatIdentifier

(ScreeningResultIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarmulighedens ID.

-    -    -    -    -    tekst

(Text)

string

MaxLength: 500

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    valgt

(Selected)

boolean

1

Angiver om svarmuligheden er valgt af borgeren.

-    -    -    -    -    ekstraTekst

(AdditionalText)

string

MaxLength: 1000

0 - 1

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

-    BackgroundVariables

BackgroundVariableTypeCollection

1

De variabler der ligger til grund for screeningen.

-    -    BackgroundVariableType

BackgroundVariableType

0 - *

-    -    -    Name

string

MaxLength: 200

1

Parameterens navn.

-    -    -    DisplayName

string

MaxLength: 200

1

Id på Spørgeskemaets resultatet

-    oprettelsestidspunkt

(CreatedDate)

dateTime

1

Angiver det tidspunkt spørgeskemaresultatet er dannet.

-    tekst

(Text)

string

1

Den kvitteringstekst borgeren præsenteres for efter endt spørgeskemaundersøgelse.

-    besvarelser

(SurveyAnswers)

BesvarelserDto

1

Borgerens besvarelser på spørgeskemaet.

-    -    besvarelse

(ResultAnswerType)

BesvarelseDto

0 - *

Besvarelse

-    -    -    svarIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarets ID.

-    -    -

    spoersmaalstekst

(QuestionText)

string

MaxLength:

1

Parameterens værdi.

-    ScreeningTargetGroup

ScreeningTargetGroupTypeIdentifierType

1

Målgruppe for profilafklaring

-    ScreeningResultCategory

ScreeningResultCategoryTypeIdentifierType

0 - 1

Screeningsresultat kategori

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

4852

Screening result not found

Screening result not found

GetScreeningResultAsPdf

Denne metode giver mulighed for at hente seneste profilafklaringsresultat for en given borger 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

...

JobCenter

...

X

...

X

...

Kommune

...

X

...

STAR

...

X

Scope

Ikke defineret

Input

...

Element

...

Type

...

Detaljer

...

Forekomst

...

Beskrivelse

...

GetScreeningResultAsPdfRequest

...

GetScreeningResultAsPdfRequestType

...

1

...

-    x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

...

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

...

Borgers personnummer.

...

-    ScreeningResultIdentifier

...

guid
Base: string

...

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

...

0 - 1

...

Screeningsresultatets ID

500

1

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

-    -    -    svarmuligheder

(Choices)

SvarmulighederDto

1

 Spørgsmålets svarmuligheder.

-    -    -    -    svarmulighed (ResultAnswerChoiceType)

SvarmulighedDto

0 - *

 Svarmulighed

-    -    -    -    -    svarmulighedIdentifier

(Id)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Svarmulighedens ID.

-    -    -    -    -    tekst

(Text)

string

MaxLength: 500

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    valgt

(Selected)

boolean

1

Angiver om svarmuligheden er valgt af borgeren.

-    -    -    - - ekstraTekstTop (AdditionalTextHeader)

string

 

0 - 1

 

-    -    -    -    -    ekstraTekst

(AdditionalText)

string

MaxLength: 1000

0 - 1

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

-    - - emne

(QuestionTopic)

string

 

0 - 1

Eventuelt emne som spørgsmålene grupperes inden for

-    baggrundsvariable

(BackgroundVariables)

BaggrundsvariableDto

1

De variabler der ligger til grund for spørgeskemaet.

-    -    baggrundsvariabel (BackgroundVariableType)

BaggrundsvariabelDto

0 - *

Den enkelte baggrundsvariabel

-    -    -    navn

(Name)

string

MaxLength: 200

1

Parameterens navn.

-    -    -    visteNavn

(DisplayName)

string

MaxLength: 200

1

Parameterens viste navn.

-    -    -    vaerdi

(Value)

string

MaxLength: 200

1

Parameterens værdi.

- lokaltSpoergeskemaFindes

(LocalScreeningExists)

boolean

 

1

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

- lokaltSpoergeskemaLink

(LocalScreeningLink)

string

1

Link til lokal spørgeskemaløsning.

-   maalgruppeForSpoergeskema

(ScreeningTargetGroup)

VisiteringOgStatus.SpoegeskemaMaalgruppeCodeList

(Gl. DFDG ScreeningTargetGroupTypeIdentifierType)

1

Målgruppe for spørgeskema

-    resultatkategori

(ScreeningResultCategory)

VisiteringOgStatus.ResultatKategoriCodeList

(Gl DFDG ScreeningResultCategoryTypeIdentifierType)

0 - 1

Spørgeskemas resultat kategori

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

4852

Spørgeskema resultate ikke fundet

Screening result not found

Spørgeskema resultate ikke fundet

Screening result

not found

...

not found

UpdateSpoergeskemaValgt (Post /v1/Spoergeskema/ValgtAfJobcenter)

(Gl. DFDG ToggleScreeningRegistration)

Denne metode giver mulighed for at hente ændre oplysninger om, hvorvidt der er valgt profilafklaring 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

Ikke defineret

Input

    JobCenterIdentifier    ScreeningRegistrationCollectionScreeningRegistrationTypeCollection profilafklaringer    ScreeningRegistrationType    ScreeningTargetGroupScreeningTargetGroupTypeIdentifierType profilafklaring.    Enabled

Element

Type

Detaljer

Forekomst

Beskrivelse

get

ToggleScreeningRegistrationRequest

ToggleScreeningRegistrationRequestType

1

-

    jobcenterkode

(JobCenterIdentifier)

string

1

Identifikation af jobcenter.

-

    spoergeskemaer

(ScreeningRegistrationCollection)

spoergeskemaerDto

1

Samling af

spørgeskemaer.

-    -

    spoergeskema

(ScreeningRegistrationType)

SpoergeskemaDto

0 - *

Det enkelte spørgeskema

-    -    -

    maalgruppeForSpoergeskema (ScreeningTargetGroup)

VisiteringOgStatus.SpoegeskemaMaalgruppeCodeList

(Gl. DFDG ScreeningTargetGroupTypeIdentifierType)

1

Målgruppe for

spørgeskema

-    -    -

    spoergeskemaValgt

(Enabled)

boolean

1

Spørgeskema er valgt for målgruppe

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

ToggleScreeningRegistrationResponse

ToggleScreeningRegistrationResponseType

1

-    ScreeningRegistrationIdentifier

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Unik identifikation af transaktion eller registrering.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

9421

9421

Et jobcenter må ikke have flere end et maalgruppeForSpoergeskema aktivt

A Jobcenter is not allowed to have multiple ScreeningTargetGroupTypes enabled

Et jobcenter må ikke have flere end et maalgruppeForSpoergeskema aktivt

A Jobcenter is not allowed to have multiple ScreeningTargetGroupTypes enabled

GetSpoergeskemaValgt (GET /v1/Spoergeskema/ValgtAfJobcenter)

(Gl. DFDG GetScreeningRegistration)

Denne metode giver mulighed for at hente oplysninger om, hvorvidt der er valgt profilafklaring 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

A-kasse

X

JobCenter

X

X

X

Kommune

X

STAR

X

Scope

Ikke defineret

Input

    JobCenterIdentifier

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaRequest

(GetScreeningRegistrationRequest)

GetScreeningRegistrationRequestType

1

-

    jobcenterkode

(JobCenterIdentifier)

string

1

Identifikation af jobcenter.

Output

    ScreeningRegistrationCollectionScreeningRegistrationTypeCollection profilafklaringer    ScreeningRegistrationType    ScreeningTargetGroupScreeningTargetGroupTypeIdentifierType profilafklaring.    Enabled

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResponse

GetScreeningRegistrationResponse

GetScreeningRegistrationResponseType

1

-

    spoergeskemaer

(ScreeningRegistrationCollection)

spoergeskemaerDto

1

Samling af

spørgeskemaer.

-    -

    spoergeskema

(ScreeningRegistrationType)

SpoergeskemaDto

0 - *

Det enkelte spørgeskema

-    -    -

    maalgruppeForSpoergeskema (ScreeningTargetGroup)

VisiteringOgStatus.SpoegeskemaMaalgruppeCodeList

(Gl. DFDG ScreeningTargetGroupTypeIdentifierType)

1

Målgruppe for

spørgeskema

-    -    -

    spoergeskemaValgt

(Enabled)

boolean

1

Spørgeskema er valgt for målgruppe

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

GetSpoergeskemaListe (GET /v1/Spoergeskema/Liste)

(Gl. DFDG GetScreeningRegistrationList)

Denne metode giver mulighed for at hente en liste over alle hovedjobcentre med oplysninger om, hvorvidt der er valgt profilafklaring spørgeskema 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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getSporgskemaerlisteRequest

GetScreeningRegistrationListRequest

GetScreeningRegistrationListRequestType

1

Output

GetScreeningRegistrationListResponseType    JobCenterScreeningRegistrationCollectionJobCenterScreeningRegistrationTypeCollection profilafklaringer     JobCenterScreeningRegistrationType    JobCenterIdentifierIdentifikation af jobcenter    JobCenterName-    ScreeningRegistrationCollectionScreeningRegistrationTypeCollection profilafklaringer    ScreeningRegistrationType    ScreeningTargetGroupScreeningTargetGroupTypeIdentifierType profilafklaring.    Enabled

Element

Type

Detaljer

Forekomst

Beskrivelse

getSporgskemaerlisteResponse

GetScreeningRegistrationListResponse

GetSporgskemaerlisteResponseDto

1

-

    jobcentersporgskemaer

(JobCenterScreeningRegistrationCollection)

JobcentersporgskemaerDto

1

Kollektion af

spørgeskemaer fra jobcenter.

-    -

    jobcentersporgskema

(JobCenterScreeningRegistrationType)

JobcentersporgskemaDto

0 - *

Spørgeskema fra jobcenter

-    -    -

    jobcenterkode

(JobCenterIdentifier)

string

1

Jobcenter kode.

-    -    -

    jobcenternavn

(JobCenterName)

string

Length: 1-50

1

Navn på jobcentret.

-    -    

-    spoergeskemaer

(ScreeningRegistrationCollection)

spoergeskemaerDto

1

Samling af

spørgeskemaer.

-    -    -    -

    spoergeskema

(ScreeningRegistrationType)

SpoergeskemaDto

0 - *

Det enkelte spørgeskema

-    -    -    -    -

    maalgruppeForSpoergeskema (ScreeningTargetGroup)

VisiteringOgStatus.SpoegeskemaMaalgruppeCodeList

(Gl. DFDG ScreeningTargetGroupTypeIdentifierType)

1

Målgruppe for

spørgeskema

-    -    -    -    -

    spoergeskemaValgt

(Enabled)

boolean

1

Spørgeskema er valgt for målgruppe

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4385

The client does not have an unemploymentfund registration

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation

GetSpoergeskemaresultater (GET /v1/Spoergeskema/Resultater)

(Gl. DFDG GetScreeningResults)

Denne metode henter en oversigtsliste af profilafklaringsresultaterspørgeskemaresultater, så aftager har en mulighed for at hente relevante profilafklaringspø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

JobCenter

X

X

Kommune

X

STAR

X

Scope

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResultatRequest

(GetScreeningResultsRequest)

GetScreeningResultsRequestType

1

-    x-civilRegistrationIdentifier [Header](PersonCivilRegistrationIdentifier)

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

Borgers personnummer.

Output

    ScreeningResultCollectionScreeningResultTypeCollection screeningsresultater    ScreeningResultType    ScreeningResultIdentifierScreeningsresultatets ID.    CreatedDate screeningsresultatet     ScreeningTargetGroupScreeningTargetGroupTypeIdentifierType profilafklaring    ScreeningResultCategoryScreeningResultCategoryTypeIdentifierTypeScreeningsresultat

Element

Type

Detaljer

Forekomst

Beskrivelse

getSpoergeskemaResultatResponse

(GetScreeningResultsResponse)

GetScreeningResultsResponseType

1

-

    spoergeskemaResultater

(ScreeningResultCollection)

SpoergeskemaResultaterDto

1

Liste af

spørgeskemaresultater.

-    -

    spoergeskemaResultat

(ScreeningResultType)

SpoergeskemaResultatDto

0 - *

Spørgeskemaresultat

-    -    -

    resultatIdentifier (ScreeningResultIdentifier)

guid
Base: string

Pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

1

Id på Spørgeskemaets resultatet

-    -    -

    oprettelsestidspunkt

(CreatedDate)

dateTime

1

Angiver det tidspunkt

spørgeskemaresultatet er dannet.

-    -    -

    maalgruppeForSpoergeskema (ScreeningTargetGroup)

VisiteringOgStatus.SpoegeskemaMaalgruppeCodeList

(Gl. DFDG ScreeningTargetGroupTypeIdentifierType)

1

Målgruppe for

spørgeskema

-    -    -

    resultatkategori (ScreeningResultCategory)

VisiteringOgStatus.ResultatKategoriCodeList

(Gl DFDG ScreeningResultCategoryTypeIdentifierType)

0 - 1

Spørgeskemas resultat kategori

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

1010

Unknown cpr

The submitted cpr is unknown to the system

1014

Failed to validate message

The submitted message could not be validated

4385

Borger har ikke et a-kassemedlemsskab

The client does not have an unemploymentfund registration

Borger har ikke et a-kassemedlemsskab

The client does not have an unemploymentfund registration

4575

You are not authorized

You are not authorized to execute the operation