Indholdsfortegnelse

1. Indledning

ID: CIVIL1
Navn: Tidligere civilstande
System: CprSoeg

1.1. Formål

Denne søgeservice giver en liste over samtlige civilstandsrækker for en person inkl. eller ekskl. de R/F-markerede rækker.

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
AIA	Binær markering	Nej	1	Angiver om der skal leveres oplysning om, hvor mange rækker der opfylder søgekriterierne (Systemafhængigt om dette ønskes).
MAXA	Heltal	Nej	4	Max antal. Angiver hvor mange rækker der ønskes læst ad gangen. Default er 20.
REST	Tekst	Nej	N/A	Restart nøgle. Internt felt med nøgler til en fortsat søgning. Der læses normalt 20 rækker ad gangen. Restart (genstart) nøglen benyttes, når de næste 20 rækker skal læses.
PNR	Personnummer	Ja	10	Personnummer
AKX	Binær markering	Nej	1	Annulleret/korrigeret markering. Angiver om rækker med 'annulleret' og 'korrigeret' markering skal medtages.

Bemærk at MAXA nøgleværdien i denne service er altid mindst 10.

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 tabel-rækker i tabel CIVIL:

Table 4. Felter der returneres pr. række i en tabel.

Felt	Format	Attributter	Beskrivelse
CCIV_AKM	Ret/fortryd markering	v,t	Ret/fortryd markering
CCIV_CIVST	Civilstandstype	v,t	Civilstandstype
CCIV_STARTDATO	Dato sekvens	v	Startdato
CCIV_STARTDATOUSM	Usikkerhedsmarkering	v	Startdato usikkerhedsmarkering
CCIV_SLUTDATO	Dato sekvens	v	Slutdato
CCIV_SLUTDATOUSM	Usikkerhedsmarkering	v	Slutdato usikkerhedsmarkering
CCIV_STARTMYNKOD	Myndighedskode	v,t,tl	Konstaterende Myndighed
CCIV_MYNTXT	Tekst	v	Civilstand myndighedstekst
CCIV_MYNTXTTIMSTP	Tidstempel	v	Civilstand myndighedstekst ajourføringsdato
CCIV_MYNTXTMYNKOD	Myndighedskode	v,t,tl	Civilstand myndighedstekst myndighed
CCIV_DOK	Binær markering (JA)	v	Verifikation
CCIV_DOKTIMSTP	Tidstempel	v	Verifikation ajourføringsdato
CCIV_DOKMYNKOD	Myndighedskode	v,t,tl	Verifikation myndighed
CCIV_AEGTEPNR	Personnummer	v	Ægtefælle personnummer
AEGTENVN	Tekst	v,t	Ægtefællenavn
CCIV_AEGTENVNMRK	Tekst	v	Ægtefælle navnemarkering
CCIV_AEGTEFOEDDATO	Dato	v	Ægtefælle fødselsdato
CCIV_AEGTEFOEDDATOUSM	Usikkerhedsmarkering	v	Ægtefælle fødselsdato usikkerhedsmarkering
CNVN_STATUS	Status	v,t,ts,tm,tl	Status
CCIV_CIVTIMSTP	Tidstempel	v	Civilstand ajourføringsdato
CCIV_TIMSTP	Tidstempel	v	Ajourføringsdato
CCIV_SYSTEMTIMSTP	Tidstempel	v	Oprettelsesdato
CCIV_SEPHENVISTIMSTP	Tidstempel	v	Separation henvisning id
CBSK_TYP1	Beskyttelsestype	v,t	Beskyttelsestype
CNVN_FORNVNMRK	Tekst	v	Fornavn markering
CNVN_MELNVNMRK	Tekst	v	Mellemnavn markering
CNVN_EFTERNVNMRK	Tekst	v	Efternavn markering
CNVN_SLAEGTNVNMRK	Tekst	v	Eget efternavn markering
CCIV_HENVISTIMSTP	Tidstempel	v	Henvisning id

5. Appendiks

5.1. GCTP Søgeservices

5.1.1. GCTP Eksempler

I de kommende eksempler vises, hvorledes requests og svar ser ud fra servicen. Bemærk at der ikke er medtaget konkrete data eller attributter i eksemplerne. I feltoversigten er der angivet felter som har attributter, men helt generelt er attributter noget der kommer med ud som svar på et request

5.1.2. Søgning

Eksempel på GCTP søgning til servicen.

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="2.0">
        <System r="CprSoeg">
            <Service r="CIVIL1">
                <CprServiceHeader r="CIVIL1">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="AKX" v="[DATA]"/>
                        <Field r="AIA" v="[DATA]"/>
                        <Field r="MAXA" v="[DATA]"/>
                        <Field r="REST" v="[DATA]"/>
                    </Key>
                </CprServiceHeader>
            </Service>
        </System>
    </Gctp>
</root>

Eksempel på et GCTP svar fra servicen.

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="2.0">
        <System r="CprSoeg">
            <Service r="CIVIL1">
                <CprServiceHeader r="CIVIL1" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="CIVIL">
                            <Row k="[ROW KEY]">
                                <Field r="CCIV_AKM" v="[DATA]"/>
                                <Field r="CCIV_CIVST" v="[DATA]"/>
                                <Field r="CCIV_STARTDATO" v="[DATA]"/>
                                <Field r="CCIV_STARTDATOUSM" v="[DATA]"/>
                                <Field r="CCIV_SLUTDATO" v="[DATA]"/>
                                <Field r="CCIV_SLUTDATOUSM" v="[DATA]"/>
                                <Field r="CCIV_STARTMYNKOD" v="[DATA]"/>
                                <Field r="CCIV_MYNTXT" v="[DATA]"/>
                                <Field r="CCIV_MYNTXTTIMSTP" v="[DATA]"/>
                                <Field r="CCIV_MYNTXTMYNKOD" v="[DATA]"/>
                                <Field r="CCIV_DOK" v="[DATA]"/>
                                <Field r="CCIV_DOKTIMSTP" v="[DATA]"/>
                                <Field r="CCIV_DOKMYNKOD" v="[DATA]"/>
                                <Field r="CCIV_AEGTEPNR" v="[DATA]"/>
                                <Field r="AEGTENVN" v="[DATA]"/>
                                <Field r="CCIV_AEGTENVNMRK" v="[DATA]"/>
                                <Field r="CCIV_AEGTEFOEDDATO" v="[DATA]"/>
                                <Field r="CCIV_AEGTEFOEDDATOUSM" v="[DATA]"/>
                                <Field r="CNVN_STATUS" v="[DATA]"/>
                                <Field r="CCIV_CIVTIMSTP" v="[DATA]"/>
                                <Field r="CCIV_TIMSTP" v="[DATA]"/>
                                <Field r="CCIV_SYSTEMTIMSTP" v="[DATA]"/>
                                <Field r="CCIV_SEPHENVISTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_TYP1" v="[DATA]"/>
                                <Field r="CNVN_FORNVNMRK" v="[DATA]"/>
                                <Field r="CNVN_MELNVNMRK" v="[DATA]"/>
                                <Field r="CNVN_EFTERNVNMRK" v="[DATA]"/>
                                <Field r="CNVN_SLAEGTNVNMRK" v="[DATA]"/>
                                <Field r="CCIV_HENVISTIMSTP" v="[DATA]"/>
                            </Row>
                        </Table>
                    </Rolle>
                </CprData>
                <Kvit r="Ok" v="0"/>
            </Service>
        </System>
    </Gctp>
</root>

Eksempel på et GCTP svar med fejl fra servicen.

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="2.0">
        <System r="CprSoeg">
            <Service r="CIVIL1">
                <CprServiceHeader r="CIVIL1" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>

CPR

CIVIL1 - Tidligere civilstande