PRIVSOGP - Privatsøgning til private

Indholdsfortegnelse

1. Indledning

ID: PRIVSOGP
Navn: PRIVATSØGNING TIL PRIVATE
System: CprSoeg

1.1. Formål

At danne en udskrift af en persons adresseoplysninger på baggrund af en søgning.

2. Adgang

2.1. Kundefokus

Brug af denne service henvender sig til private virksomheder.

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
PNRPersonnummerNej10

Personnummer

KONM eller KNej1

Køn

STAFTekstNejN/A

Statuskode fra

FODTDato (yyyyMMdd)Nej8

Fødselsdato

KOMKHeltalNej4

Kommunekode

VEJKHeltalNej4

Vejkode

VEJKODVejkodeNej4

Vejkode.

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

HNRHusnummer der indeholder op til 3 cifre og evt. husbogstavNej4

Husnummer

ETAGAdressekomponent som kan være mellem 1 og 99Nej2

Etage

SIDOAdressekomponent der kan indeholde op til 4 cifre/bogstaverNej4

Sidedør

BNRTekstNejN/A

Bygningsnummer

POSTHeltalNej4

Postnummer

NVNPTekstNejN/A

Navn

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

Navnedel nummer

NVN1TekstNejN/A

Alternativt navn 1

NVN2TekstNejN/A

Alternativt navn 2

NVN3TekstNejN/A

Alternativt navn 3

NNVNBinær markeringNej1

Nuværende navn

SADRBinær markeringNej1

Seneste adresse

RETIBinær markeringNej1

Retlig interesse

KADVBinær markeringNej1

Kreditadvarsel markering

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
2554Der er ikke fundet nogen personer med disse søgekriterier

Der er ikke fundet nogen matchende personer for de angivne søgekriterier.

2555Der er fundet mere end 1 person med disse søgekriterier

Der blev fundet for mange personer for de angivne søgekriterier. Søgningen skal give præcis 1 match.

2592Navn og køn skal angives

Både navn og køn er krævet.

2616Navn skal udfyldes med mindst 2 af personens navnedele

Der skal indsendes et navn der består af mindst 2 navnedele.

2618Der skal være mindst 2 uforkortede navnedele

Der skal indsendes et navn der består af mindst 2 hele navnedele.

2619Navn må højst indeholde 1 * ved 3 navnedele

Der skal indsendes mindst 2 hele navnedele når der angives et navn med 3 navnedele.

2620Navn må højst indeholde 2 * ved 4 navnedele

Der skal indsendes mindst 2 hele navnedele når der angives et navn med 4 navnedele.

2622Personummer, Fødselsdato eller kommune/postnr. skal udfyldes

Enten kommunekode eller postnummer skal indsendes ved adressesøgninger.

2623Vej skal udfyldes

Vejkode skal udfyldes i forb. med adressesøgninger.

2624Husnummer eller bygningsnummer skal udfyldes

Enten husnummer eller bygningsnummer skal indsendes ved adressesøgninger.

3855Vej= %1% %2% - udfyld Kommmune eller Postdistrikt

Enten kommunekode eller postdistrikt skal indsendes når der angives en vej.

3875Der 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.

3879Der kan kun være stjerne i den navnedel hvortil der er valgt stavemåde

Evt. wildcard i navn skal være i navnedelen angivet i NDNR nøgleværdien.

3880Der kan kun være underscore i den navnedel hvortil der er valgt stavemåde

Evt. udeladte bogstaver i navn skal være i navnedelen angivet i NDNR nøgleværdien.

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.

4163Der er ikke overensstemmelse mellem køn og personnummer

Personnummeret og køn skal hænge sammen. Kvider har lige personnumre og mænd har ulige personnumre.

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.

Vær opmærksom på at der kun returneres de felter, der indeholder data.

Servicen returnerer følgende felter:

Table 4. Felter der returneres.
FeltFormatAttributterBeskrivelse
PNRFODTTekstv

Personnummer eller fødselsdato afhængig af søgekriterier

STATUS-LINIETekstv

Status linie

STARTDATODatov

Startdato

TILFLYDTODatov

Tilflytningsdato

TILFLY_USMUsikkerhedsmarkeringv,t

Tilflytningsdato usikkerhedsmarkering

ADRNVNTekstv,t

Adresseringsnavn

ADR1Tekstv

Adresselinje 1

ADR2Tekstv

Adresselinje 2

ADR3Tekstv

Adresselinje 3

ADR4Tekstv

Adresselinje 4

ADR5Tekstv

Adresselinje 5

ADR6Tekstv

Adresselinje 6

BESKTXTTekstv

Tekst vedrørende beskyttelsestype

REKBESKBinær markering (X)v,t

Reklamebeskyttelse

KREDADVBinær markering (X)v,t

Kreditadvarsel markering

KOMMUNEKommunekodev,t,tl

Kommunekode

RETSKREDSMyndighedskodev,t,tl

Retskreds

STILLINGTekstv

Stilling

VAERGE1TXTTekstv

Tekstlinie

VAERGEDTODatov

Startdato

VAERGE2TXTTekstv

Tekstlinie

VAERGENVNTekstv,t

Værges adresseringsnavn

VAERGEADR1Tekstv

Værge adresselinie 1

VAERGEADR2Tekstv

Værge adresselinie 2

VAERGEADR3Tekstv

Værge adresselinie 3

VAERGEADR4Tekstv

Værge adresselinie 4

VAERGEADR5Tekstv

Værge adresselinie 5

KONTAKTADR1Tekstv

Kontakt adresselinje 1

KONTAKTADR2Tekstv

Kontakt adresselinje 2

KONTAKTADR3Tekstv

Kontakt adresselinje 3

KONTAKTADR4Tekstv

Kontakt adresselinje 4

KONTAKTADR5Tekstv

Kontakt adresselinje 5

VAERGEMAALS_TYPETekstv,t

Værgemåls type

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="PRIVSOGP">
                <CprServiceHeader r="PRIVSOGP">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="KON" v="[DATA]"/>
                        <Field r="STAF" v="[DATA]"/>
                        <Field r="FODT" v="[DATA]"/>
                        <Field r="KOMK" v="[DATA]"/>
                        <Field r="VEJK" v="[DATA]"/>
                        <Field r="VEJKOD" v="[DATA]"/>
                        <Field r="HNR" v="[DATA]"/>
                        <Field r="ETAG" v="[DATA]"/>
                        <Field r="SIDO" v="[DATA]"/>
                        <Field r="BNR" v="[DATA]"/>
                        <Field r="POST" v="[DATA]"/>
                        <Field r="NVNP" v="[DATA]"/>
                        <Field r="NDNR" v="[DATA]"/>
                        <Field r="NVN1" v="[DATA]"/>
                        <Field r="NVN2" v="[DATA]"/>
                        <Field r="NVN3" v="[DATA]"/>
                        <Field r="NNVN" v="[DATA]"/>
                        <Field r="SADR" v="[DATA]"/>
                        <Field r="RETI" v="[DATA]"/>
                        <Field r="KADV" 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="PRIVSOGP">
                <CprServiceHeader r="PRIVSOGP" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Field r="PNRFODT" v="[DATA]"/>
                        <Field r="STATUS-LINIE" v="[DATA]"/>
                        <Field r="STARTDATO" v="[DATA]"/>
                        <Field r="TILFLYDTO" v="[DATA]"/>
                        <Field r="TILFLY_USM" v="[DATA]"/>
                        <Field r="ADRNVN" v="[DATA]"/>
                        <Field r="ADR1" v="[DATA]"/>
                        <Field r="ADR2" v="[DATA]"/>
                        <Field r="ADR3" v="[DATA]"/>
                        <Field r="ADR4" v="[DATA]"/>
                        <Field r="ADR5" v="[DATA]"/>
                        <Field r="ADR6" v="[DATA]"/>
                        <Field r="BESKTXT" v="[DATA]"/>
                        <Field r="REKBESK" v="[DATA]"/>
                        <Field r="KREDADV" v="[DATA]"/>
                        <Field r="KOMMUNE" v="[DATA]"/>
                        <Field r="RETSKREDS" v="[DATA]"/>
                        <Field r="STILLING" v="[DATA]"/>
                        <Field r="VAERGE1TXT" v="[DATA]"/>
                        <Field r="VAERGEDTO" v="[DATA]"/>
                        <Field r="VAERGE2TXT" v="[DATA]"/>
                        <Field r="VAERGENVN" v="[DATA]"/>
                        <Field r="VAERGEADR1" v="[DATA]"/>
                        <Field r="VAERGEADR2" v="[DATA]"/>
                        <Field r="VAERGEADR3" v="[DATA]"/>
                        <Field r="VAERGEADR4" v="[DATA]"/>
                        <Field r="VAERGEADR5" v="[DATA]"/>
                        <Field r="KONTAKTADR1" v="[DATA]"/>
                        <Field r="KONTAKTADR2" v="[DATA]"/>
                        <Field r="KONTAKTADR3" v="[DATA]"/>
                        <Field r="KONTAKTADR4" v="[DATA]"/>
                        <Field r="KONTAKTADR5" v="[DATA]"/>
                        <Field r="VAERGEMAALS_TYPE" 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">
        <System r="CprSoeg">
            <Service r="PRIVSOGP">
                <CprServiceHeader r="PRIVSOGP" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>