Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version 2.0.0

...

Anchor
_indledning
_indledning
1. Indledning

Info

ID: AKTDATAP
Navn: Aktuelle oplysninger til private
System: CprSoeg

Anchor
_formål
_formål
1.1. Formål

Servicen AKTDATAP har til formål at hente en persons aktuelle oplysninger.

Anchor
_adgang
_adgang

...

2. Adgang

Anchor
_kundefokus
_kundefokus

...

2.1. Kundefokus

Brug af denne service henvender sig til private virksomheder.

Anchor
_adgangskontrol
_adgangskontrol

...

2.2. Adgangskontrol

Services er underlagt adgangsprincipper som en del af adgangskontrollen til en service[1]. Nedenstående tabel viser, hvilke adgangsprincipper der gælder for AKTDATAPdenne 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.

Anchor
_

...

nøglefelter
_

...

nøglefelter

...

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.

...

Table 2. Nøglefelter.
FeltFormatKrævetFeltlængde (v)Beskrivelse
PNRPersonnummerJa10

Personnummer

Anchor
_nøgleregler
_nøgleregler

...

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

Fejlbesked i ovenstående er ikke den fejlbesked, der sendes i svaret. Den fejl der returneres hentes ud fra fejlkoden. Den generel dokumentation af fejlkoder og beskeder ses her [TODO her kommer der et link til udtræk af fejlkoder fra ctkvit]

Endvidere er der fælles regler, der kan komme i anvendelse. Disse er beskrevet i et af 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.

Generelle systemfejlkoder der ikke henvender sig til servicen eller dens data, findes også i servicehåndbogen i et bilag vedr. generelle fejlkoder.

...

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 felter:

...

Personnummer

...

Personnummer

...

Køn

...

Fødselsdato

...

Usikkerhedsmarkering

...

Status

...

Startdato

...

Usikkerhedsmarkering

...

Navne-/adressebeskyttelse

...

Markedsføringsbeskyttelse

...

Fornavn

...

Mellemnavn

...

Efternavn

...

Adresseringsnavn

...

C/o navn

...

Standardadresse

...

Startdato

...

Kommunekode

...

Vejkode

...

Vejadresseringsnavn

...

Husnummer

...

Etage

...

Sidedør nummer

...

Bygningsnummer

...

Lokalitet (Udgået)

...

Bynavn

...

Postnummer

...

Startdato

...

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 tidligere i dokumentet.

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

Anchor
_gctp_eksempler
_gctp_eksempler
4.1. GCTP Eksempler

Se Appendiks.

Anchor
_søgnings_resultats_datafelter
_søgnings_resultats_datafelter
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.
FeltFormatAttributterBeskrivelse
PNRPersonnummerv

Personnummer

PNRGAELDPersonnummerv

Personnummer

KOENTekstv

Køn

FOEDDATODatov

Fødselsdato

FOEDDATOUSMUsikkerhedsmarkeringv

Usikkerhedsmarkering

STATUSStatusv,t

Status

STARTDATOSTATUSDatov

Startdato

STATUSDATOUSMUsikkerhedsmarkeringv

Usikkerhedsmarkering

ADRBESKYTNumeriskv,t,ts

Navne-/adressebeskyttelse

MARBESKYTNumeriskv,t,ts

Markedsføringsbeskyttelse

FORNVNTekstv

Fornavn

MELNVNTekstv

Mellemnavn

EFTERNVNTekstv

Efternavn

ADRNVNTekstv,t

Adresseringsnavn

CONVNTekstv

C/o navn

STADRTekstv

Standardadresse

STARTDATODato sekvensv

Startdato

KOMKODKommunekodev,t,tl

Kommunekode

VEJKODNumeriskv,t

Vejkode

VEJADRNVNTekstv

Vejadresseringsnavn

HUSNRHusnummerv

Husnummer

ETAGEEtagev

Etage

SIDEDOERSidedørv

Sidedør nummer

BNRBygningsnummerv

Bygningsnummer

LOKALITETUdgået

Lokalitet (Udgået)

BYNVNTekstv

Bynavn

POSTNRPostnummerv,t

Postnummer

CUMN_STARTDATODatov

Startdato

Anchor
_appendiks
_appendiks
5. Appendiks

Anchor
_gctp_søgeservices
_gctp_søgeservices
5.1. GCTP Søgeservices

Anchor
gctp_eksempler_appendiks
gctp_eksempler_appendiks
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

Anchor
_søgning
_søgning

...

5.1.2. Søgning

Code Block
languagexml
titleEksempel 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="AKTDATAP">
                <CprServiceHeader r="AKTDATAP">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                    </Key>
                </CprServiceHeader>
            </Service>
        </System>
    </Gctp>
</root>

...

Code Block
languagexml
titleEksempel 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="AKTDATAP">
                <CprServiceHeader r="AKTDATAP" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>

...