CitizenScreeningService (Version 1, 2021-1)

Siden opdateres automatisk til at afspejle koden. CodeFirst.

 

Metoder

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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetFirstGroupOfQuestionsRequest

GetFirstGroupOfQuestionsRequestType

 

1

 

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetFirstGroupOfQuestionsResponse

GetFirstGroupOfQuestionsResponseType

 

1

 

-    Questions

QuestionTypeCollection

 

1

 

-    -    QuestionType

QuestionType

 

0 - *

 

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

-    -    -    Text

string

 

1

Spørgsmålets tekst

-    -    -    Category

QuestionTypeCategoryEnum
Base: string

Enumeration:

  • SingleChoice

  • MultipleChoice

1

Angiver typen af spørgsmål

-    -    -    Options

QuestionOptionTypeCollection

 

1

 

-    -    -    -    QuestionOptionType

QuestionOptionType

 

0 - *

 

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

-    -    -    -    -    Text

string

 

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    Category

QuestionOptionTypeCategoryEnum
Base: string

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)

-    -    -    -    -    Selected

boolean

 

1

 

-    -    -    -    -    AdditionalTextHeader

string

 

0 - 1

 

-    -    -    -    -    AdditionalText

string

 

0 - 1

 

-    -    -    Topic

string

 

1

Eventuelt emne som spørgsmålene grupperes inden for

-    CurrentSurveyStep

int

 

1

Angiver nuværende trin i spørgeskemaet

-    TotalSurveySteps

int

 

1

Angiver det totale antal trin i spørgeskemaet

Fejlkoder

Ingen fejlkoder

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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetNextGroupOfQuestionsRequest

GetNextGroupOfQuestionsRequestType

 

1

 

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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.

-    Answers

AnswerTypeCollection

 

1

 

-    -    AnswerType

AnswerType

 

0 - *

 

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

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

-    -    -    Choices

AnswerChoiceTypeCollection

 

1

 

-    -    -    -    AnswerChoiceType

AnswerChoiceType

 

0 - *

 

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

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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetNextGroupOfQuestionsResponse

GetNextGroupOfQuestionsResponseType

 

1

 

-    Questions

QuestionTypeCollection

 

1

 

-    -    QuestionType

QuestionType

 

0 - *

 

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

-    -    -    Text

string

 

1

Spørgsmålets tekst

-    -    -    Category

QuestionTypeCategoryEnum
Base: string

Enumeration:

  • SingleChoice

  • MultipleChoice

1

Angiver typen af spørgsmål

-    -    -    Options

QuestionOptionTypeCollection

 

1

 

-    -    -    -    QuestionOptionType

QuestionOptionType

 

0 - *

 

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

-    -    -    -    -    Text

string

 

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    Category

QuestionOptionTypeCategoryEnum
Base: string

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)

-    -    -    -    -    Selected

boolean

 

1

 

-    -    -    -    -    AdditionalTextHeader

string

 

0 - 1

 

-    -    -    -    -    AdditionalText

string

 

0 - 1

 

-    -    -    Topic

string

 

1

Eventuelt emne som spørgsmålene grupperes inden for

-    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

-    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

-    TotalSurveySteps

int

 

1

Angiver det totale antal trin i spørgeskemaet

Fejlkoder

Ingen fejlkoder

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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

SubmitAndPerformScreeningRequest

SubmitAndPerformScreeningRequestType

 

1

 

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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

Element

Type

Detaljer

Forekomst

Beskrivelse

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

GetScreeningResult

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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultRequest

GetScreeningResultRequestType

 

1

 

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultResponse

GetScreeningResultResponseType

 

1

 

-    CreatedDate

dateTime

 

1

Angiver det tidspunkt screeningsresultatet er dannet.

-    Text

string

 

1

Den tekst borgeren præsenteres for efter endt screening.

-    SurveyAnswers

ResultAnswerTypeCollection

 

1

Borgerens besvarelser på spørgeskemaet.

-    -    ResultAnswerType

ResultAnswerType

 

0 - *

 

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

 

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

-    -    -    -    -    Text

string

 

1

Svarmulighedens beskrivelsestekst.

-    -    -    -    -    Selected

boolean

 

1

Angiver om svarmuligheden er valgt af borgeren.

-    -    -    -    -    AdditionalTextHeader

string

 

0 - 1

 

-    -    -    -    -    AdditionalText

string

 

1

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

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

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

 

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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultAsPdfRequest

GetScreeningResultAsPdfRequestType

 

1

 

-    PersonCivilRegistrationIdentifier

PersonCivilRegistrationIdentifierType
Base: 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

Element

Type

Detaljer

Forekomst

Beskrivelse

GetScreeningResultAsPdfResponse

GetScreeningResultAsPdfResponseType

 

1

 

-    Data

base64Binary

 

1

Screening Result som Pdf.

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

4852

Screening result not found

Screening result not found