Versions Compared

Key

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

Siden opdateres af FA

Metoder

Table of Contents
maxLevel2

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

...

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

...

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)

...

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

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

 

 

 

 

 

 

 

...

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

A-kasse

X

JobCenter

X

X

Kommune

X

STAR

X

...

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.

...

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.

...

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

UpdateSpoergeskemaValgt (Post /v1/Spoergeskema/ValgtAfJobcenter)

(Gl. DFDG ToggleScreeningRegistration)

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.

...

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

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 spørgeskema for hver af de tre målgrupper (borgere under 30, borgere over 30 eller dagpengemodtagere) for det angivne hovedjobcenter.

...

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 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.

...

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 spørgeskemaresultater, så aftager har en mulighed for at hente relevante spørgeskema.

...