Indholdsfortegnelse

1. Indledning

ID: ADRESSE1
Navn: Tidligere adresser
System: CprSoeg

1.1. Formål

Servicen leverer en liste over en persons aktuelle og historiske adresser.

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.

Keymodel til Adresse1

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	Angiver om søgningen også leverer rettede og fortrudte rækker.

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

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

Felt	Format	Attributter	Beskrivelse
TIMSTP	Tidstempel	v	Ajourføringsdato
SYSTEM_TS	Tidstempel	v	Oprettelsesdato
ADRTS	Tidstempel	v	Tilflytnings-/udrejse_/forsvindings-ajourføringsdato
AKM	Ret/fortryd markering	v,t	Ret/fortryd markering
MYNKOD	Myndighedskode	v,t,tl	Konstaterende myndighed
ADRKOD	Adressetypekode	v	Kode der angiver om adressen er dansk, udenlandsk eller en forsvinding. Samt oplysning om oplysningen ligger på arkiv.
UDRLANDEKOD	Landekode	v,t,tl	Udrejse landekode
STARTDATO	Dato sekvens	v	Tilflytnings-/udrejse-/forsvindingsdato
STARTDATOUSM	Usikkerhedsmarkering	v	Tilflytnings-/udrejse-/forsvindings-dato usikkerhedsmarkering
SLUTDATO	Dato sekvens	v	Fraflytnings-/indrejse-/genfindingsdato
SLUTDATOUSM	Usikkerhedsmarkering	v	Fraflytnings-/indrejse-/genfindingsdato usikkerhedsmarkering
SLUT_TS	Tidstempel	v	Adresse sluttidspunkt
INDRLANDEKOD	Landekode	v,t,tl	Indrejse landekode
UDLANDSADR1	Tekst	v	Udlandsadresse 1
UDLANDSADR2	Tekst	v	Udlandsadresse 2
UDLANDSADR3	Tekst	v	Udlandsadresse 3
UDLANDSADR4	Tekst	v	Udlandsadresse 4
UDLANDSADR5	Tekst	v	Udlandsadresse 5
UDLANDADR_MYNKOD	Myndighedskode	v,t,tl	Udlandsadresse konstaterende myndighed
UDLANDADR_TS	Tidstempel	v	Udlandsadresse ajourføringstidspunkt
HUSNR	Husnummer	v	Husnummer
ETAGE	Etage	v	Etage
SIDEDOER	Sidedør	v	Sidedør nummer
VEJKOD	Numerisk	v,t,tl	Vejkode
BNR	Bygningsnummer	v	Bygningsnummer
TILFLYKOMDTO	Dato sekvens	v	Tilflyttet kommune dato
TILFLYKOMDTOUSM	Usikkerhedsmarkering	v	Tilflyttet kommune dato usikkerhedsmarkering
FRAFLYKOMDTO	Dato sekvens	v	Fraflyttet kommune dato
FRAFLYKOMDTOUSM	Usikkerhedsmarkering	v	Tilflyttet kommune dato usikkerhedsmarkering
CONVN	Tekst	v	C/o navn
CONVNTS	Tidstempel	v	C/o navn ajourføringstidspunkt
KOMKOD	Kommunekode	v,t,tl	Kommunekode
POSTNR	Postnummer	v,t	Postnummer
BYNVN	Tekst	v	Bynavn
LOKALITET	Udgået		Lokalitet (Udgået)
STADR	Tekst	v	Standardadresse

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="ADRESSE1">
                <CprServiceHeader r="ADRESSE1">
                    <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="ADRESSE1">
                <CprServiceHeader r="ADRESSE1" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="ADRESSE">
                            <Row k="[ROW KEY]">
                                <Field r="TIMSTP" v="[DATA]"/>
                                <Field r="SYSTEM_TS" v="[DATA]"/>
                                <Field r="ADRTS" v="[DATA]"/>
                                <Field r="AKM" v="[DATA]"/>
                                <Field r="MYNKOD" v="[DATA]"/>
                                <Field r="ADRKOD" v="[DATA]"/>
                                <Field r="UDRLANDEKOD" v="[DATA]"/>
                                <Field r="STARTDATO" v="[DATA]"/>
                                <Field r="STARTDATOUSM" v="[DATA]"/>
                                <Field r="SLUTDATO" v="[DATA]"/>
                                <Field r="SLUTDATOUSM" v="[DATA]"/>
                                <Field r="SLUT_TS" v="[DATA]"/>
                                <Field r="INDRLANDEKOD" v="[DATA]"/>
                                <Field r="UDLANDSADR1" v="[DATA]"/>
                                <Field r="UDLANDSADR2" v="[DATA]"/>
                                <Field r="UDLANDSADR3" v="[DATA]"/>
                                <Field r="UDLANDSADR4" v="[DATA]"/>
                                <Field r="UDLANDSADR5" v="[DATA]"/>
                                <Field r="UDLANDADR_MYNKOD" v="[DATA]"/>
                                <Field r="UDLANDADR_TS" v="[DATA]"/>
                                <Field r="HUSNR" v="[DATA]"/>
                                <Field r="ETAGE" v="[DATA]"/>
                                <Field r="SIDEDOER" v="[DATA]"/>
                                <Field r="VEJKOD" v="[DATA]"/>
                                <Field r="BNR" v="[DATA]"/>
                                <Field r="TILFLYKOMDTO" v="[DATA]"/>
                                <Field r="TILFLYKOMDTOUSM" v="[DATA]"/>
                                <Field r="FRAFLYKOMDTO" v="[DATA]"/>
                                <Field r="FRAFLYKOMDTOUSM" v="[DATA]"/>
                                <Field r="CONVN" v="[DATA]"/>
                                <Field r="CONVNTS" v="[DATA]"/>
                                <Field r="KOMKOD" v="[DATA]"/>
                                <Field r="POSTNR" v="[DATA]"/>
                                <Field r="BYNVN" v="[DATA]"/>
                                <Field r="LOKALITET" v="[DATA]"/>
                                <Field r="STADR" 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="ADRESSE1">
                <CprServiceHeader r="ADRESSE1" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>

Browser not supported