Indholdsfortegnelse

1. Indledning

ID: BESKYT1
Navn: Tidligere beskyttelse
System: CprSoeg

1.1. Formål

Denne service returnerer en liste med samtlige beskyttelser for en person, både aktuelle og historiske.

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
MAXA	Heltal	Nej	4	Max antal. Angiver hvor mange rækker der ønskes læst ad gangen. Default er 20.
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).
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
HISM	Binær markering	Nej	1	Angiver om aktuelle og historiske beskyttelser skal grupperes i forskellige tabeller
KADV	X, E eller blank	Nej	N/A	Angiver hvilke beskyttelser søgning skal levere tilbage

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.

Afhængig af HISMRK værdien leveres der forskellige tabeller tilbage i svaret. Når HISMRK er indstillet til X, grupperes beskyttelser i AKTBESKYT og HISBESKYT tabeller:

AKTBESKYT tabellen indeholder evt. aktuelle beskyttelser for personnummeret.
HISBESKYT tabellen indeholder evt. historiske beskyttelser for personnummeret.

Hvis ikke HISMRK er indstillet til X leveres alle beskyttelser tilbage i BESKYT tabellen. Det vil sige at der enten svares tilbage med både AKTBESKYT og HISBESKYT tabeller, eller kun BESKYT tabellen. Aktuelle beskyttelser indgår i BESKYT tabellen.

Eventuel REST (restart) nøgle forekommer kun i HISBESKYT eller BESKYT tabeller og aldrig i AKTBESKYT tabellen. Hvis servicen kaldes med en REST nøgle undlades AKTBESKYT tabellen fra responsen.

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

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

Felt	Format	Attributter	Beskrivelse
CBSK_TIMSTP	Tidstempel	v	Ajourføringsdato
CBSK_SYSTEMTIMSTP	Tidstempel	v	Oprettelsesdato
CBSK_TYP	Beskyttelsestype	v,t,ts,tm,tl	Beskyt type
CBSK_STARTMYNKOD	Myndighedskode	v,t,tl	Konstaterende myndighed
CBSK_STARTTIMSTP	Tidstempel	v	Startdato ajourføringstidspunkt
CBSK_STARTDATO	Dato	v	Startdato
CBSK_INDRAP	Binær markering (JA/NEJ)	v	Indrapporteret markering
CBSK_SLETDATO	Dato	v	Slettedato
CBSK_SLUTMYNKOD	Myndighedskode	v,t,tl	Slutdato konstaterende myndighed
CBSK_SLUTTIMSTP	Tidstempel	v	Slutdato ajourføringsdato
CBSK_SLUTDATO	Dato	v	Slutdato

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

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

Felt	Format	Attributter	Beskrivelse
CBSK_TIMSTP	Tidstempel	v	Ajourføringsdato
CBSK_SYSTEMTIMSTP	Tidstempel	v	Oprettelsesdato
CBSK_TYP	Beskyttelsestype	v,t,ts,tm,tl	Beskyt type
CBSK_STARTMYNKOD	Myndighedskode	v,t,tl	Konstaterende myndighed
CBSK_STARTTIMSTP	Tidstempel	v	Startdato ajourføringstidspunkt
CBSK_STARTDATO	Dato	v	Startdato
CBSK_INDRAP	Binær markering (JA/NEJ)	v	Indrapporteret markering
CBSK_SLETDATO	Dato	v	Slettedato
CBSK_SLUTMYNKOD	Myndighedskode	v,t,tl	Slutdato konstaterende myndighed
CBSK_SLUTTIMSTP	Tidstempel	v	Slutdato ajourføringsdato
CBSK_SLUTDATO	Dato	v	Slutdato

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

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

Felt	Format	Attributter	Beskrivelse
CBSK_TIMSTP	Tidstempel	v	Ajourføringsdato
CBSK_SYSTEMTIMSTP	Tidstempel	v	Oprettelsesdato
CBSK_TYP	Beskyttelsestype	v,t,ts,tm,tl	Beskyt type
CBSK_STARTMYNKOD	Myndighedskode	v,t,tl	Konstaterende myndighed
CBSK_STARTTIMSTP	Tidstempel	v	Startdato ajourføringstidspunkt
CBSK_STARTDATO	Dato	v	Startdato
CBSK_INDRAP	Binær markering (JA/NEJ)	v	Indrapporteret markering
CBSK_SLETDATO	Dato	v	Slettedato
CBSK_SLUTMYNKOD	Myndighedskode	v,t,tl	Slutdato konstaterende myndighed
CBSK_SLUTTIMSTP	Tidstempel	v	Slutdato ajourføringsdato
CBSK_SLUTDATO	Dato	v	Slutdato

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="BESKYT1">
                <CprServiceHeader r="BESKYT1">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="HISM" v="[DATA]"/>
                        <Field r="KADV" v="[DATA]"/>
                        <Field r="MAXA" v="[DATA]"/>
                        <Field r="AIA" 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="BESKYT1">
                <CprServiceHeader r="BESKYT1" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="AKTBESKYT">
                            <Row k="[ROW KEY]">
                                <Field r="CBSK_TIMSTP" v="[DATA]"/>
                                <Field r="CBSK_SYSTEMTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_TYP" v="[DATA]"/>
                                <Field r="CBSK_STARTMYNKOD" v="[DATA]"/>
                                <Field r="CBSK_STARTTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_STARTDATO" v="[DATA]"/>
                                <Field r="CBSK_INDRAP" v="[DATA]"/>
                                <Field r="CBSK_SLETDATO" v="[DATA]"/>
                                <Field r="CBSK_SLUTMYNKOD" v="[DATA]"/>
                                <Field r="CBSK_SLUTTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_SLUTDATO" v="[DATA]"/>
                            </Row>
                        </Table>
                        <Table r="HISBESKYT">
                            <Row k="[ROW KEY]">
                                <Field r="CBSK_TIMSTP" v="[DATA]"/>
                                <Field r="CBSK_SYSTEMTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_TYP" v="[DATA]"/>
                                <Field r="CBSK_STARTMYNKOD" v="[DATA]"/>
                                <Field r="CBSK_STARTTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_STARTDATO" v="[DATA]"/>
                                <Field r="CBSK_INDRAP" v="[DATA]"/>
                                <Field r="CBSK_SLETDATO" v="[DATA]"/>
                                <Field r="CBSK_SLUTMYNKOD" v="[DATA]"/>
                                <Field r="CBSK_SLUTTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_SLUTDATO" v="[DATA]"/>
                            </Row>
                        </Table>
                        <Table r="BESKYT">
                            <Row k="[ROW KEY]">
                                <Field r="CBSK_TIMSTP" v="[DATA]"/>
                                <Field r="CBSK_SYSTEMTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_TYP" v="[DATA]"/>
                                <Field r="CBSK_STARTMYNKOD" v="[DATA]"/>
                                <Field r="CBSK_STARTTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_STARTDATO" v="[DATA]"/>
                                <Field r="CBSK_INDRAP" v="[DATA]"/>
                                <Field r="CBSK_SLETDATO" v="[DATA]"/>
                                <Field r="CBSK_SLUTMYNKOD" v="[DATA]"/>
                                <Field r="CBSK_SLUTTIMSTP" v="[DATA]"/>
                                <Field r="CBSK_SLUTDATO" 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="BESKYT1">
                <CprServiceHeader r="BESKYT1" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>

CPR

BESKYT1 - Tidligere beskyttelse