FODSOG1 - Fødselsdato-søgning

FODSOG1 - Fødselsdato-søgning

Indholdsfortegnelse

1. Indledning

ID: FODSOG1
Navn: Fødselsdato-søgning
System: CprSoeg

1.1. Formål

Søgning på fødselsdato.

Data kan afgrænses med køn, kommune, fødselsregistrerings-sted, status, statsborgerskab og navn (inklusiv synonymer eller stavemåder).

Bemærk at de personer, som indgår i søgeresultaterne, er baseret på en efterhånden konsistent datakilde. Datakilden opdateres typisk hvert 10. minut med de seneste ændringer i CPR-data.

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.

KON

M eller K

Nej

1

Køn

FODT

Dato (yyyyMMdd)

Nej

8

Fødselsdato

NVN

Tekst

Nej

N/A

Navne

HNVS

Binær markering

Nej

1

Inkluder tidligere navne

KOMK

Heltal

Nej

4

Kommunekode

LDEL

Heltal

Nej

4

Landsdel

STB

Heltal

Nej

4

Statsborgerskab

STAF

Statuskoden angiver om et personnummer (person) er aktiv eller inaktiv, samt andre oplysninger - se værdimængde

Nej

N/A

Statuskode

FREG

Heltal

Nej

4

Fødselsregistreringssted

NVN1

Tekst

Nej

N/A

Alternativt navn 1

NVN2

Tekst

Nej

N/A

Alternativt navn 2

NVN3

Tekst

Nej

N/A

Alternativt navn 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: ST1, ST2, ST3, ST4, SY1, SY2, SY3, SY4

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

628

Feltet skal være udfyldt

Når HNVS-feltet er udfyldt skal NVN-feltet også være udfyldt.

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.

3935

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

Når NDNR-feltet er udfyldt skal NVN1-feltet også være udfyldt.

4047

Der 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 FOEDSOEG:

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

Felt

Format

Attributter

Beskrivelse

PNR

Personnummer

v

Personnummer

ADRNVN

Tekst

v,t

Adresseringsnavn

CNVN_STATUS

Status

v,t,ts,tl

Status

FOEDMYNKOD

Myndighedskode

v,t,tl

Myndighed

FOEDMYNTXT

Tekst

v

Myndighedstekst for fødselsregistreringssted

ADRBESKYT

Numerisk

v,t,tm,tl

Navne-/adressebeskyttelse

KOEN

Tekst

v

Køn

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="FODSOG1"> <CprServiceHeader r="FODSOG1"> <Key> <Field r="KON" v="[DATA]"/> <Field r="FODT" v="[DATA]"/> <Field r="NVN" v="[DATA]"/> <Field r="HNVS" v="[DATA]"/> <Field r="KOMK" v="[DATA]"/> <Field r="LDEL" v="[DATA]"/> <Field r="STB" v="[DATA]"/> <Field r="STAF" v="[DATA]"/> <Field r="FREG" v="[DATA]"/> <Field r="NVN1" v="[DATA]"/> <Field r="NVN2" v="[DATA]"/> <Field r="NVN3" v="[DATA]"/> <Field r="NDNR" 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="FODSOG1"> <CprServiceHeader r="FODSOG1" ts="20220830222305987643"/> <CprData u="O"> <Rolle r="HovedRolle"> <Table r="FOEDSOEG"> <Row k="[ROW KEY]"> <Field r="PNR" v="[DATA]"/> <Field r="ADRNVN" v="[DATA]"/> <Field r="CNVN_STATUS" v="[DATA]"/> <Field r="FOEDMYNKOD" v="[DATA]"/> <Field r="FOEDMYNTXT" v="[DATA]"/> <Field r="ADRBESKYT" v="[DATA]"/> <Field r="KOEN" 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="FODSOG1"> <CprServiceHeader r="FODSOG1" ts="20220830222305987643"/> <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/> </Service> </System> </Gctp> </root>