Indholdsfortegnelse

1. Indledning

ID: ADRSOG1
Navn: Adressesøgning
System: CprSoeg

1.1. Formål

Søgemodul til adressesøgning

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
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.
KOMK	Heltal	Nej	4	Kommunekode
KOMKOD	Kommunekode	Nej	4	Kommunekode
VEJK	Heltal	Nej	4	Vejkode
VEJKOD	Vejkode	Nej	4	Vejkode
VNVN	Tekst	Nej	N/A	Vejnavn
POST	Heltal	Nej	4	Postnummer
HIST	Binær markering	Nej	1	Historik ønskes
ARKV	Binær markering	Nej	1	Arkivrækker ønskes
NVN	Tekst	Nej	N/A	Navn
NVN1	Tekst	Nej	N/A	Navn alternativ 1
NVN2	Tekst	Nej	N/A	Navn alternativ 2
NVN3	Tekst	Nej	N/A	Navn alternativ 3
NDNR	Navnedel der skal søges på: ST1, ST2, ST3, ST4 (stavemåder) eller SY1, SY2, SY3, SY4 (synonymer)	Nej	N/A	Navnedel nummer. Valide værdier i denne service: SY1, SY2, SY3
KON	M eller K	Nej	1	Køn
FDTO	Dato (yyyyMMdd)	Nej	8	Fra dato
TDTO	Dato (yyyyMMdd)	Nej	8	Til dato
BNR	Tekst	Nej	4	Bygningsnummer
HNR	Husnummer der indeholder op til 3 cifre og evt. husbogstav	Nej	4	Husnummer
HNRF	Husnummer der indeholder op til 3 cifre og evt. husbogstav	Nej	4	Husnummer fra
HNRT	Husnummer der indeholder op til 3 cifre og evt. husbogstav	Nej	4	Husnummer til
LIUL	Tekst	Nej	N/A	Lige ulige
ETAG	Adressekomponent som kan være mellem 1 og 99	Nej	2	Etage
SIDO	Adressekomponent der kan indeholde op til 4 cifre/bogstaver	Nej	4	Sidedør
AKTM	Binær markering	Nej	1	Aktuelmarkering
HISM	Binær markering	Nej	1	Historikmarkering
ARKM	Binær markering	Nej	1	Arkivmarkering
AKTK	Binær markering	Nej	1	Aktionskode
NOBR	Binær markering	Nej	1	Ingen break
AKX	Binær markering	Nej	1	Medtag ret/fortryd-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
48	Valide værdier er L og U	Der må maks angives 4 navne i NVN-feltet.
1048	Kombinationen af søgekriterier er ikke mulig !	Der skal være angivet en valid kombination af søgekriterier.
1068	Kun et af de 2 felter må udfyldes	Validerer at kun et af husnummer eller bygningsnr, husnummer eller husnummer-fra, husnummer eller ligeulige, arkm eller postnr,
2244	Man kan ikke søge på postnr 9999	Validerer at postnummer ikke er 9999
2268	Man kan ikke søge på postnr OG høj vejkode	Validerer at der ikke søges med høj vejkode sammen med postnummer.
3884	Der kan kun være underscore ' _' ifm. Stavesøgning	Udeladte bogstaver (`_`) må ikke bruges medmindre der angives andre stavemåder.
3885	Der kan kun være stjerne midt i en navnedel ifm. Stavesøgning	Der må maks angives 4 navne i NVN-feltet.
3931	Der skal være mindst 1 ekstra navn, når navnedel er udfyldt Der skal være mindst 1 ekstra navn, når navnedel er udfyldt Fejl	Validerer at der er mindst 1 ekstra navn, når navnedel er udfyldt.
4047	Der kan kun vælges dobbelte ekstra navne, når der er mindre end 4 navnedele i navnet	Der må maks angives 4 navne i NVN-feltet.

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

Table 4. Felter der returneres.

Felt	Format	Attributter	Beskrivelse
SEARCH_ID	Tekst	v	Søge id

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

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

Felt	Format	Attributter	Beskrivelse
BEMAERK	Tekst	v	Bemærkning
VEJKOD	Numerisk	v,t,tl	Vejkode
KOMKOD	Kommunekode	v,t,tl	Kommunekode
HUSNR	Husnummer	v	Husnummer
ETAGE	Etage	v	Etage
SIDEDOER	Sidedør	v	Sidedør nummer
BNR	Bygningsnummer	v	Bygningsnummer
PNR	Personnummer	v	Personnummer
CNVN_ADRNVN	Tekst	v,t	Adresseringsnavn
ADRBESKYT	Numerisk	v,t,ts,tm,tl	Navne-/adressebeskyttelse
STARTDATO	Dato	v	Startdato
SLUTDATO	Dato	v	Slutdato
CNVN_STATUS	Status	v,t,ts,tm,tl	Status
AKM	Ret/fortryd markering	v,t	Ret/fortryd markering
TABMRK	null	null	Feltet mangler i json

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="ADRSOG1">
                <CprServiceHeader r="ADRSOG1">
                    <Key>
                        <Field r="KOMK" v="[DATA]"/>
                        <Field r="KOMKOD" v="[DATA]"/>
                        <Field r="VEJK" v="[DATA]"/>
                        <Field r="VEJKOD" v="[DATA]"/>
                        <Field r="VNVN" v="[DATA]"/>
                        <Field r="POST" v="[DATA]"/>
                        <Field r="HIST" v="[DATA]"/>
                        <Field r="ARKV" v="[DATA]"/>
                        <Field r="NVN" v="[DATA]"/>
                        <Field r="NVN1" v="[DATA]"/>
                        <Field r="NVN2" v="[DATA]"/>
                        <Field r="NVN3" v="[DATA]"/>
                        <Field r="NDNR" v="[DATA]"/>
                        <Field r="KON" v="[DATA]"/>
                        <Field r="FDTO" v="[DATA]"/>
                        <Field r="TDTO" v="[DATA]"/>
                        <Field r="BNR" v="[DATA]"/>
                        <Field r="HNR" v="[DATA]"/>
                        <Field r="HNRF" v="[DATA]"/>
                        <Field r="HNRT" v="[DATA]"/>
                        <Field r="LIUL" v="[DATA]"/>
                        <Field r="ETAG" v="[DATA]"/>
                        <Field r="SIDO" v="[DATA]"/>
                        <Field r="AKTM" v="[DATA]"/>
                        <Field r="HISM" v="[DATA]"/>
                        <Field r="ARKM" v="[DATA]"/>
                        <Field r="AKTK" v="[DATA]"/>
                        <Field r="NOBR" 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="ADRSOG1">
                <CprServiceHeader r="ADRSOG1" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Field r="SEARCH_ID" v="[DATA]"/>
                        <Table r="ADRSOG">
                            <Row k="[ROW KEY]">
                                <Field r="BEMAERK" v="[DATA]"/>
                                <Field r="VEJKOD" v="[DATA]"/>
                                <Field r="KOMKOD" v="[DATA]"/>
                                <Field r="HUSNR" v="[DATA]"/>
                                <Field r="ETAGE" v="[DATA]"/>
                                <Field r="SIDEDOER" v="[DATA]"/>
                                <Field r="BNR" v="[DATA]"/>
                                <Field r="PNR" v="[DATA]"/>
                                <Field r="CNVN_ADRNVN" v="[DATA]"/>
                                <Field r="ADRBESKYT" v="[DATA]"/>
                                <Field r="STARTDATO" v="[DATA]"/>
                                <Field r="SLUTDATO" v="[DATA]"/>
                                <Field r="CNVN_STATUS" v="[DATA]"/>
                                <Field r="AKM" v="[DATA]"/>
                                <Field r="TABMRK" 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="ADRSOG1">
                <CprServiceHeader r="ADRSOG1" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>

ADRSOG1 - Adressesøgning