BESKYT3 - Nuværende beskyttelse

Indholdsfortegnelse

1. Indledning

ID: BESKYT3
Navn: Nuværende beskyttelse
System: CprSoeg

1.1. Formål

Visning af personens nuværende beskyttelsesrække(r) samt en markering af om der findes tidligere beskyttelser.

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
PNRPersonnummerJa10

Personnummer

KADVX, E eller blankNejN/A

Angiver hvilke beskyttelser søgning skal levere tilbage.

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

Tallet i slutningen af feltnavnet angiver beskyttelsestypen feltet hører til. Mulige beskyttelsestyper:

  • 1: Navne- og adressebeskyttelse
  • 2: Lokalvejviser beskyttelse
  • 3: Markedsføringsbeskyttelse
  • 5: Kreditadvarsel

Bemærk at servicen har forskellige svartyper afhængig af følgende kriterier:

  1. Hvis ikke personen har aktuelle beskyttelser returneres der kun BESKYT-HIS-AN feltet i svaret.
  2. Hvis valgfri KADV nøglen mangler i opslaget returneres der ikke kreditadvarsel (beskyttelsestype 5) felter i svaret.
  3. Hvis valgfri KADV nøglen er udfyldt med værdi X returneres der alle felter i svaret
  4. Hvis valgfri KADV nøglen er udfyldt med værdi E returneres der alle felter i svaret, men kun kreditadvarsel (beskyttelsestype 5) felter udfyldes med data.

Servicen returnerer følgende felter:

Table 4. Felter der returneres.
FeltFormatAttributterBeskrivelse
BESKYT-HIS-ANNumeriskv

Tidligere beskyttelser antal

CBSK_TIMSTP1Tidstempelv

Ajourføringsdato

CBSK_SYSTEMTIMSTP1Tidstempelv

Oprettelsesdato

CBSK_TYP1Beskyttelsestypev,t,ts,tm,tl

Beskyt type

CBSK_STARTMYNKOD1Myndighedskodev,t,tl

Konstaterende myndighed

CBSK_STARTTIMSTP1Tidstempelv

Startdato ajourføringstidspunkt

CBSK_STARTDATO1Datov

Startdato

CBSK_INDRAP1Binær markering (JA/NEJ)v

Indrapporteret markering

CBSK_SLETDATO1Datov

Slettedato

CBSK_TIMSTP2Tidstempelv

Ajourføringsdato

CBSK_SYSTEMTIMSTP2Tidstempelv

Oprettelsesdato

CBSK_TYP2Beskyttelsestypev,t,ts,tm,tl

Beskyt type

CBSK_STARTMYNKOD2Myndighedskodev,t,tl

Konstaterende myndighed

CBSK_STARTTIMSTP2Tidstempelv

Startdato ajourføringstidspunkt

CBSK_STARTDATO2Datov

Startdato

CBSK_INDRAP2Binær markering (JA/NEJ)v

Indrapporteret markering

CBSK_SLETDATO2Datov

Slettedato

CBSK_TIMSTP3Tidstempelv

Ajourføringsdato

CBSK_SYSTEMTIMSTP3Tidstempelv

Oprettelsesdato

CBSK_TYP3Beskyttelsestypev,t,ts,tm,tl

Beskyt type

CBSK_STARTMYNKOD3Myndighedskodev,t,tl

Konstaterende myndighed

CBSK_STARTTIMSTP3Tidstempelv

Startdato ajourføringstidspunkt

CBSK_STARTDATO3Datov

Startdato

CBSK_INDRAP3Binær markering (JA/NEJ)v

Indrapporteret markering

CBSK_SLETDATO3Datov

Slettedato

CBSK_TIMSTP5Tidstempelv

Ajourføringsdato

CBSK_SYSTEMTIMSTP5Tidstempelv

Oprettelsesdato

CBSK_TYP5Beskyttelsestypev,t,ts,tm,tl

Beskyt type

CBSK_STARTMYNKOD5Myndighedskodev,t,tl

Konstaterende myndighed

CBSK_STARTTIMSTP5Tidstempelv

Startdato ajourføringstidspunkt

CBSK_STARTDATO5Datov

Startdato

CBSK_INDRAP5Binær markering (JA/NEJ)v

Indrapporteret markering

CBSK_SLETDATO5Datov

Slettedato

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="BESKYT3">
                <CprServiceHeader r="BESKYT3">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="KADV" 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="BESKYT3">
                <CprServiceHeader r="BESKYT3" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Field r="BESKYT-HIS-AN" v="[DATA]"/>
                        <Field r="CBSK_TIMSTP1" v="[DATA]"/>
                        <Field r="CBSK_SYSTEMTIMSTP1" v="[DATA]"/>
                        <Field r="CBSK_TYP1" v="[DATA]"/>
                        <Field r="CBSK_STARTMYNKOD1" v="[DATA]"/>
                        <Field r="CBSK_STARTTIMSTP1" v="[DATA]"/>
                        <Field r="CBSK_STARTDATO1" v="[DATA]"/>
                        <Field r="CBSK_INDRAP1" v="[DATA]"/>
                        <Field r="CBSK_SLETDATO1" v="[DATA]"/>
                        <Field r="CBSK_TIMSTP2" v="[DATA]"/>
                        <Field r="CBSK_SYSTEMTIMSTP2" v="[DATA]"/>
                        <Field r="CBSK_TYP2" v="[DATA]"/>
                        <Field r="CBSK_STARTMYNKOD2" v="[DATA]"/>
                        <Field r="CBSK_STARTTIMSTP2" v="[DATA]"/>
                        <Field r="CBSK_STARTDATO2" v="[DATA]"/>
                        <Field r="CBSK_INDRAP2" v="[DATA]"/>
                        <Field r="CBSK_SLETDATO2" v="[DATA]"/>
                        <Field r="CBSK_TIMSTP3" v="[DATA]"/>
                        <Field r="CBSK_SYSTEMTIMSTP3" v="[DATA]"/>
                        <Field r="CBSK_TYP3" v="[DATA]"/>
                        <Field r="CBSK_STARTMYNKOD3" v="[DATA]"/>
                        <Field r="CBSK_STARTTIMSTP3" v="[DATA]"/>
                        <Field r="CBSK_STARTDATO3" v="[DATA]"/>
                        <Field r="CBSK_INDRAP3" v="[DATA]"/>
                        <Field r="CBSK_SLETDATO3" v="[DATA]"/>
                        <Field r="CBSK_TIMSTP5" v="[DATA]"/>
                        <Field r="CBSK_SYSTEMTIMSTP5" v="[DATA]"/>
                        <Field r="CBSK_TYP5" v="[DATA]"/>
                        <Field r="CBSK_STARTMYNKOD5" v="[DATA]"/>
                        <Field r="CBSK_STARTTIMSTP5" v="[DATA]"/>
                        <Field r="CBSK_STARTDATO5" v="[DATA]"/>
                        <Field r="CBSK_INDRAP5" v="[DATA]"/>
                        <Field r="CBSK_SLETDATO5" v="[DATA]"/>
                    </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="BESKYT3">
                <CprServiceHeader r="BESKYT3" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>