NVNSOG2 - Navnesøgning - udvidet

Indholdsfortegnelse

1. Indledning

ID: NVNSOG2
Navn: Navnesøgning - udvidet
System: CprSoeg

1.1. Formål

Denne servicen bruges når man primært har navn og køn at søge med. Søgningen kan også begrænses med yderligere søgekriterier.

Forskellen mellem denne servicen og NVNSOG1 servicen er, at denne service leverer udvidet data i responsen.

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
AIABinær markeringNej1

Angiver om der skal leveres oplysning om, hvor mange rækker der opfylder søgekriterierne (Systemafhængigt om dette ønskes).

MAXAHeltalNej4

Max antal.
Angiver hvor mange rækker der ønskes læst ad gangen.
Default er 20.

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

KONM eller KJa1

Køn

NVNTekstNejN/A

Navne

NVN1TekstNejN/A

Navn 1

NVN2TekstNejN/A

Navn 2

NVN3TekstNejN/A

Navn 3

NDNRNavnedel der skal søges på: ST1, ST2, ST3, ST4 (stavemåder) eller SY1, SY2, SY3, SY4 (synonymer)NejN/A

Navnedel nummer.

ALDFHeltalNejN/A

Alder fra

ALDTHeltalNejN/A

Alder til

HNVSBinær markeringNej1

Inkluder historiske navne

KOMKHeltalNej4

Kommunekode

KOMKODKommunekodeNej4

Kommunekode

Bemærk at dette felt eksisterer kun af hensyn til bagudkompatibilitet med ældre klienter, der ved en fejl benytter KOMKOD som feltreference i stedet for KOMK. KOMKOD inputfeltet kan blive fjernet i fremtiden og derfor skal KOMK inputfeltet bruges i stedet.

FREGHeltalNej4

Fødselsregistreringssted

LDELHeltalNej4

Landsdel

STBHeltalNej4

Statsborgerskab

STAFStatuskoden angiver om et personnummer (person) er aktiv eller inaktiv, samt andre oplysninger - se værdimængdeNejN/A

Status fra

STATStatuskoden angiver om et personnummer (person) er aktiv eller inaktiv, samt andre oplysninger - se værdimængdeNejN/A

Status til

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
862Der er for mange der opfylder kriteriet!

Der findes for mange personer der opfylder søgekriteriet. Begræns søgningen yderligere.

3267Der kan kun udsøges personer født fra og med 01-01-1858.

Aldersintervallet i ALDT/ALDF nøgleværdierne skal begrænses.

3836Der skal angives et korrekt aldersinterval.

Alder fra skal være mindre end eller lig med alder til.

3854Der skal være mindst 1 ekstra navn, når navnedel er udfyldt

Når NDNNR nøgleværdien indsendes skal der også indsendes en eller flere værdier i de ekstra navnefelter.

3884Der kan kun være underscore ' _' ifm. Stavesøgning

Udeladte bogstaver (_) må ikke bruges medmindre der angives andre stavemåder.

3885Der kan kun være stjerne midt i en navnedel ifm. Stavesøgning

Der må maks angives 4 navne i NVN-feltet.

4047Der kan kun vælges dobbelte ekstra navne, når der er mindre end 4 navnedele i navnet

Der må ikke angives flere end 1 navn i de alternative navnefelter når NVN-feltet indeholder 4 navne.

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

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

Personnummer

CNVN_ADRNVNTekstv,t

Adresseringsnavn

CNVN_STATUSStatusv,t,ts,tl

Status

FOEDMYNKODMyndighedskodev,t,tl

Myndighed

FOEDMYNTXTTekstv

Myndighedstekst for fødselsregistreringssted

CNVN_KOENTekstv

Køn

ADRBESKYTNumeriskv,t,tm,tl

Navne-/adressebeskyttelse

STADRTekstv

Standardadresse

POSTNRPostnummerv,t

Postnummer

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="NVNSOG2">
                <CprServiceHeader r="NVNSOG2">
                    <Key>
                        <Field r="KON" 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="ALDF" v="[DATA]"/>
                        <Field r="ALDT" v="[DATA]"/>
                        <Field r="HNVS" v="[DATA]"/>
                        <Field r="KOMK" v="[DATA]"/>
                        <Field r="KOMKOD" v="[DATA]"/>
                        <Field r="FREG" v="[DATA]"/>
                        <Field r="LDEL" v="[DATA]"/>
                        <Field r="STB" v="[DATA]"/>
                        <Field r="STAF" v="[DATA]"/>
                        <Field r="STAT" 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="NVNSOG2">
                <CprServiceHeader r="NVNSOG2" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="NVNSOG">
                            <Row k="[ROW KEY]">
                                <Field r="PNR" v="[DATA]"/>
                                <Field r="CNVN_ADRNVN" v="[DATA]"/>
                                <Field r="CNVN_STATUS" v="[DATA]"/>
                                <Field r="FOEDMYNKOD" v="[DATA]"/>
                                <Field r="FOEDMYNTXT" v="[DATA]"/>
                                <Field r="CNVN_KOEN" v="[DATA]"/>
                                <Field r="ADRBESKYT" v="[DATA]"/>
                                <Field r="STADR" v="[DATA]"/>
                                <Field r="POSTNR" 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="NVNSOG2">
                <CprServiceHeader r="NVNSOG2" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>