Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Indholdsfortegnelse

1. Indledning

  • ID: ADRESSE3
  • Navn: Nuværende adresse
  • System: CprSoeg

1.1. Formål

Visning af personens aktuelle adresserække samt markeringer af:

  • Om der findes historiske adresserækker
  • Om personen har kontaktadresse
  • Om personen har supplerende adresse
  • Om personen har flyttepåbud

2. Adgang

2.1. Kundefokus

Brug af denne service henvender sig kun 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

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, herunder feltets navn, format maxlængde på value(v) attributten, om feltet er påkrævet, samt en beskrivelse af feltet.

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

Personnummer

AKXBinær markeringNej1

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

  • 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, 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:

Table 4. Felter der returneres.
FeltFormatAttributterBeskrivelse
TIDLADRMRKTekstv

Markering

KONTAKTADRMRKTekstv

Markering

TIDLKOMMRKTekstv

Markering

SUPADRMRKTekstv

Markering

ADRKODAdressetypekodev

Kode der angiver om adressen er dansk, udenlandsk eller en forsvinding. Samt oplysning om oplysningen ligger på arkiv.

TIMSTPTidstempelv

Ajourføringsdato

SYSTEM_TSTidstempelv

Oprettelsesdato

ADRTSTidstempelv

Tilflytnings-/udrejse_/forsvindings-ajourføringsdato

MYNKODMyndighedskodev,t,tl

Myndighed

VEJKODNumeriskv,t,tl

Vejkode

HUSNRHusnummerv

Husnummer

ETAGEEtagev

Etage

SIDEDOERSidedørv

Sidedør nummer

BNRBygningsnummerv

Bygningsnummer

TILFRA_MYNKODMyndighedskodev,t,tl

Myndighed

TILFLYKOMDATODatov

Startdato

TILFLYKOMDATOUSMUsikkerhedsmarkeringv

Usikkerhedsmarkering

FRAFLYKOMKODNumeriskv,t,tl

Fraflytning kommune

FRAFLYKOMDATODatov

Slutdato

FRAFLYKOMDATOUSMUsikkerhedsmarkeringv

Usikkerhedsmarkering

CONVNTekstv

C/o navn

CONVNTSTidstempelv

Ajourføringsdato

BYNVNTekstv

Bynavn

LOKALITETUdgået

Lokalitet (Udgået)

POSTNRPostnummerv,t

Postnummer

STARTDATODatov

Startdato

STARTDATOUSMUsikkerhedsmarkeringv

Startdato usikkerhedsmarkering

KOMKODKommunekodev,t,tl

Kommunekode

UDRLANDEKODLandekodev,t,tl

Landekode

UDLANDSADR1Tekstv

Udlandsadresse 1

UDLANDSADR2Tekstv

Udlandsadresse 2

UDLANDSADR3Tekstv

Udlandsadresse 3

UDLANDSADR4Tekstv

Udlandsadresse 4

UDLANDSADR5Tekstv

Udlandsadresse 5

UDLANDADR_TSTidstempelv

Ajourføringsdato

UDLANDADR_MYNKODMyndighedskodev,t,tl

Myndighed

FLYTPAMRKTekstv

Markering

RETSKREDSMyndighedskodev,t,tl

Retskreds

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 felt oversigten er angivet felter der 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" env="Udvikling">
        <System r="CprSoeg">
            <Service r="ADRESSE3">
                <CprServiceHeader r="ADRESSE3">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="AKX" 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" env="Udvikling">
        <System r="CprSoeg">
            <Service r="ADRESSE3">
                <CprServiceHeader r="ADRESSE3" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Field r="TIDLADRMRK" v="[DATA]"/>
                        <Field r="KONTAKTADRMRK" v="[DATA]"/>
                        <Field r="TIDLKOMMRK" v="[DATA]"/>
                        <Field r="SUPADRMRK" v="[DATA]"/>
                        <Field r="ADRKOD" v="[DATA]"/>
                        <Field r="TIMSTP" v="[DATA]"/>
                        <Field r="SYSTEM_TS" v="[DATA]"/>
                        <Field r="ADRTS" v="[DATA]"/>
                        <Field r="MYNKOD" v="[DATA]"/>
                        <Field r="VEJKOD" v="[DATA]"/>
                        <Field r="HUSNR" v="[DATA]"/>
                        <Field r="ETAGE" v="[DATA]"/>
                        <Field r="SIDEDOER" v="[DATA]"/>
                        <Field r="BNR" v="[DATA]"/>
                        <Field r="TILFRA_MYNKOD" v="[DATA]"/>
                        <Field r="TILFLYKOMDATO" v="[DATA]"/>
                        <Field r="TILFLYKOMDATOUSM" v="[DATA]"/>
                        <Field r="FRAFLYKOMKOD" v="[DATA]"/>
                        <Field r="FRAFLYKOMDATO" v="[DATA]"/>
                        <Field r="FRAFLYKOMDATOUSM" v="[DATA]"/>
                        <Field r="CONVN" v="[DATA]"/>
                        <Field r="CONVNTS" v="[DATA]"/>
                        <Field r="BYNVN" v="[DATA]"/>
                        <Field r="LOKALITET" v="[DATA]"/>
                        <Field r="POSTNR" v="[DATA]"/>
                        <Field r="STARTDATO" v="[DATA]"/>
                        <Field r="STARTDATOUSM" v="[DATA]"/>
                        <Field r="KOMKOD" v="[DATA]"/>
                        <Field r="UDRLANDEKOD" 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_TS" v="[DATA]"/>
                        <Field r="UDLANDADR_MYNKOD" v="[DATA]"/>
                        <Field r="FLYTPAMRK" v="[DATA]"/>
                        <Field r="RETSKREDS" 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" env="Udvikling">
        <System r="CprSoeg">
            <Service r="ADRESSE3">
                <CprServiceHeader r="ADRESSE3" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>
  • No labels