Indholdsfortegnelse

1. Indledning

ID: HAENKAT1
Navn: Personnr-søgning på hændelseskatalog for personer
System: CprSoeg

1.1. Formål

Denne søgning anvendes til at udtrække en liste fra hændelseskataloget for personer for et personnummer.

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.
PrincipGælder
AdgangskontrolJa

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.
FeltFormatKrævetFeltlængde (v)Beskrivelse
AIABinær markeringNej1

Angiver om der skal leveres oplysning om, hvor mange rækker der opfylder søgekriterierne (Systemafhængigt om dette ønskes).

MAXAHeltalNej4

Max antal.
Angiver hvor mange rækker der ønskes læst ad gangen.
Default er 20.

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

PNRPersonnummerJa10

Personnummer

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.
FejlkodeFejlbeskedBeskrivelse
Der er ingen servicespecifikke nøgleregler til denne service

Den generel dokumentation af fejlkoder og beskeder 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:

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, tl). Hvis der ikke findes data til en attribut sættes attributten ikke for feltet.

Herunder angives feltets navn, formatet på v(alue) attributten, hvilke attributter der kan forekomme på feltet og en beskrivelse af feltet.

Servicen returnerer følgende tabel-rækker i tabel HAENKAT:

Table 4. Felter der returneres pr. række i en tabel.
FeltFormatAttributterBeskrivelse
CHKP_AFLEDTMRKTekstv,t

Afledt hændelse markering

CHKP_HAENIDTekstv,t

Hændelse katalog hændelse ident

CHKP_INDBERETMYNKODMyndighedskodev,t

Myndighedskode indberet

CHKP_PRIMAERTIMSTPTidstempelv

Timestamp

CHKP_STARTDATODatov

Startdato

CHKP_TIMSTPTidstempelv

Ajourføringsdato

CHKP_PERSKODTekstv

Hændelse katalog personkode

CHKP_KOMKODFKommunekodev,t

Kommunekode før

CHKP_KOMKODEKommunekodev,t

Kommunekode efter

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

<?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="HAENKAT1">
                <CprServiceHeader r="HAENKAT1">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="AIA" v="[DATA]"/>
                        <Field r="MAXA" v="[DATA]"/>
                        <Field r="REST" v="[DATA]"/>
                    </Key>
                </CprServiceHeader>
            </Service>
        </System>
    </Gctp>
</root>
<?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="HAENKAT1">
                <CprServiceHeader r="HAENKAT1" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="HAENKAT">
                            <Row k="[ROW KEY]">
                                <Field r="CHKP_AFLEDTMRK" v="[DATA]"/>
                                <Field r="CHKP_HAENID" v="[DATA]"/>
                                <Field r="CHKP_INDBERETMYNKOD" v="[DATA]"/>
                                <Field r="CHKP_PRIMAERTIMSTP" v="[DATA]"/>
                                <Field r="CHKP_STARTDATO" v="[DATA]"/>
                                <Field r="CHKP_TIMSTP" v="[DATA]"/>
                                <Field r="CHKP_PERSKOD" v="[DATA]"/>
                                <Field r="CHKP_KOMKODF" v="[DATA]"/>
                                <Field r="CHKP_KOMKODE" v="[DATA]"/>
                            </Row>
                        </Table>
                    </Rolle>
                </CprData>
                <Kvit r="Ok" v="0"/>
            </Service>
        </System>
    </Gctp>
</root>
<?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="HAENKAT1">
                <CprServiceHeader r="HAENKAT1" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>