CIVIL3 - Nuværende civilstand

CIVIL3 - Nuværende civilstand

Indholdsfortegnelse

1. Indledning

ID: CIVIL3
Navn: Nuværende civilstand
System: CprSoeg

1.1. Formål

Denne søgeservice returnerer information om en persons civilstand

2. Adgang

2.1. Kundefokus

Brug af denne service henvender sig til offentlige myndigheder.

2.2. Adgangskontrol

Services er underlagt adgangsprincipper som en del af adgangskontrollen til en service. Nedenstående tabel viser, hvilke adgangsprincipper der gælder for denne service.

Table 1. Hovedprincipper for adgangskontrol på servicen.

Princip

Gælder

Adgangskontrol

Ja

Adgangskontrol

For at en bruger kan kalde denne service skal brugerens personkode have en profil tilknyttet, der giver adgang til servicen. Profiler tildeles til en personkode enten af personkodens DAP-administrator eller ved oprettelse af personkoden.

3. Nøglefelter

Når søgningen kaldes, er der visse kriterier, der kan forventes indsendt og derfor er påkrævet, mens andre kriterier kan være frivillige, og derfor ikke er påkrævet.

Herunder beskrives de felter der kan anvendes under initiering.

Table 2. Nøglefelter.

Felt

Format

Krævet

Feltlængde (v)

Beskrivelse

PNR

Personnummer

Ja

10

Personnummer

AKX

Binær markering

Nej

1

Inkluder annulleret/korrigeret rækker

3.1. Nøgleregler

Søgningen kan fejle med en række fejlkoder, hvis de indsendte kriterier ikke accepteres af servicen.

Table 3. Fejl der kan opstå ud fra søgekriterier.

Fejlkode

Fejlbesked

Beskrivelse

Der er ingen servicespecifikke nøgleregler til denne service

Den generelle dokumentation af fejlkoder og fejltekster står beskrevet i servicehåndbogens bilag vedr. generelle fejlkoder.

Endvidere er der fælles regler, der kan komme i anvendelse. Disse er beskrevet i servicehåndbogens bilag ang. fælles nøgleregler.

4. GCTP

Dette afsnit præsenterer en håndfuld ukomplette eksempler på de kald denne service kan modtage, og svarene den vil sende retur.

Formålet med eksemplerne er, at give et generelt overblik af hvordan GCTP er struktureret for denne service med fokus på de søgekriterier, en bruger kan interagere med og felter der returneres.

Disse begrænsninger har følgende konsekvenser for eksemplerne:

  • For <Field>-elementer til nøglefelter

    • Data er udeladt, og er i stedet markeret med attributten v="[DATA]".

    • Alle andre attributter er udeladt (a, a1, t, osv).

  • For <Field>-elementer til søgning svar

    • Data er udeladt, og er i stedet markeret med attributten v="[DATA]".

  • For <Table>-element til søgning svar

    • <Row>-elementets identificerende nøgle er udeladt, og er i stedet markeret med attributten k="[ROW KEY]"

    • <Field>-Data er udeladt og er i stedet markeret med attributten v="[DATA]".

    • Der er kun elementer for 1 række.

  • For <Kvit>-element til kvittering ved fejl

    • Data er udeladt, og er i stedet markeret med attributten for fejlnummer v="[DATA]" og for fejltekst t="[DATA]".

De felter, der er udeladt i disse eksempler, er beskrevet i deres respektive afsnit i dette dokumentet.

4.1. GCTP Eksempler

Se Appendiks.

4.2. Søgnings resultats datafelter

Data der returneres er beskrevet i denne sektion.

Hvert felt har et navn og kan have et antal attributter (v, t, ts, tm, tl, bv). Hvis der ikke findes data til en attribut sættes attributten ikke for feltet.

Servicen returnerer følgende felter:

Table 4. Felter der returneres.

Felt

Format

Attributter

Beskrivelse

CCIV_TIMSTP

Tidstempel

v

Ajourføringsdato

CCIV_SYSTEMTIMSTP

Tidstempel

v

Oprettelsesdato

CCIV_SEPHENVISTIMSTP

Tidstempel

v

Separation henvisning timestamp

CCIV_STARTMYNKOD

Myndighedskode

v,t,tl

Konstaterende Myndighed

CCIV_CIVTIMSTP

Tidstempel

v

Ajourføringsdato

CCIV_CIVST

Civilstandstype

v,t,ts,tm,tl

Ægteskabelige stilling

CCIV_AEGTEPNR

Personnummer

v

Ægefælles personnummer

CCIV_AEGTEFOEDDATO

Dato

v

Ægtefælle fødselsdato

CCIV_AEGTEFOEDDATOUSM

Usikkerhedsmarkering

v

Ægtefælle fødselsdato usikkerhedsmarkering

AEGTENVN

Tekst

v,t

Ægtefælle navn

CCIV_AEGTENVNMRK

Tekst

v

Ægtefælle navnemarkering

CNVN_STATUS

Status

v,t,ts,tm,tl

Status

CBSK_TYP1

Beskyttelsestype

v,t,ts,tm,tl

Beskyt type

CCIV_STARTDATO

Dato sekvens

v

Civilstand startdato

CCIV_STARTDATOUSM

Usikkerhedsmarkering

v

Civilstand startdato usikkerhedsmarkering

CCIV_DOKMYNKOD

Myndighedskode

v,t,tl

Verifikation myndighed

CCIV_DOKTIMSTP

Tidstempel

v

Verifikation ajourføringsdato

CCIV_DOK

Binær markering (JA)

v

Verifikation

CCIV_MYNTXTMYNKOD

Myndighedskode

v,t,tl

Myndighed for alternativ myndighedstekst

CCIV_MYNTXTTIMSTP

Tidstempel

v

Ajourføringsdato for myndighedstekst

CCIV_MYNTXT

Tekst

v

Alternativt myndighedstekst

HENVISTIMSTP

Tidstempel

v

Henvisning id

HISTORIKMRK

Binær markering (X)

v

Indikation af om der findes historiske rækker