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

« Previous Version 2 Next »

1. Indledning

ID: NAVNE3
Navn: Nuværende navn
System: CprSoeg

Denne service returnerer personens aktuelle navnerække samt en markering af om der findes historiske navnerækker.

2. Adgang

Brug af denne service henvender sig kun til offentlige myndigheder.

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
PNRPersonnummerJa10

Personnummer

AKXBinær markeringNej1

Annulleret/korrigeret markering

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.

Se Appendiks.

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
CNVN_TIMSTPTidstempelv

Ajourføringsdato

CNVN_SYSTEMTIMSTPTidstempelv

Oprettelsesdato

CNVN_STATUSStatusv,t,ts,tm,tl

Status

CNVN_STATUSTIMSTPTidstempelv

Status ajourføringsdato

CNVN_STATUSSTARTDATODatov

Status startdato

CNVN_STATUSDATOUSMUsikkerhedsmarkeringv

Status startdato usikkerhedsmarkering

CNVN_KOENTekstv

Køn

CNVN_STARTMYNKODMyndighedskodev,t,tl

Konstaterende myndighed

CNVN_NVNTIMSTPTidstempelv

Navn ajourføringsdato

CNVN_FORNVNTekstv

Fornavn

CNVN_FORNVNMRKTekstv

Fornavn markering

CNVN_MELNVNTekstv

Mellemnavn

CNVN_MELNVNMRKTekstv

Mellemnavn markering

CNVN_EFTERNVNTekstv

Efternavn

CNVN_EFTERNVNMRKTekstv

Efternavn markering

CNVN_SLAEGTNVNTekstv

Eget efternavn

CNVN_SLAEGTNVNMRKTekstv

Eget efternavn markering

CNVN_STARTDATODatov

Startdato

CNVN_STARTDATOUSMUsikkerhedsmarkeringv

Startdato usikkerhedsmarkering

CNVN_ADRNVNMYNKODMyndighedskodev,t,tl

Adresseringsnavn konstaterende myndighed

CNVN_ADRNVNTIMSTPTidstempelv

Adresseringsnavn ajourføringsdato

CNVN_ADRNVNTekstv,t

Adresseringsnavn

CNVN_INDRAPTekstv

Indrapporteret markering

CNVN_DOKMYNKODMyndighedskodev,t,tl

Verifikation myndighed

CNVN_DOKTIMSTPTidstempelv

Verifikation ajourføringsdato

CNVN_DOKTekstv

Verifikation markering

CNVN_MYNTXTMYNKODMyndighedskodev,t,tl

Navne myndighedstekst myndighed

CNVN_MYNTXTTIMSTPTidstempelv

Myndighedstekst ajourføringstidspunkt

CNVN_MYNTXTTekstv

Navne myndighedstekst

HISTORIKMRKTekstv

Historik markering

5. Appendiks

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

Eksempel på GCTP søgning til servicen.
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root>
    <Gctp v="2.0" env="Udvikling">
        <System r="CprSoeg">
            <Service r="NAVNE3">
                <CprServiceHeader r="NAVNE3">
                    <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>
    <Gctp v="2.0" env="Udvikling">
        <System r="CprSoeg">
            <Service r="NAVNE3">
                <CprServiceHeader r="NAVNE3" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Field r="CNVN_TIMSTP" v="[DATA]"/>
                        <Field r="CNVN_SYSTEMTIMSTP" v="[DATA]"/>
                        <Field r="CNVN_STATUS" v="[DATA]"/>
                        <Field r="CNVN_STATUSTIMSTP" v="[DATA]"/>
                        <Field r="CNVN_STATUSSTARTDATO" v="[DATA]"/>
                        <Field r="CNVN_STATUSDATOUSM" v="[DATA]"/>
                        <Field r="CNVN_KOEN" v="[DATA]"/>
                        <Field r="CNVN_STARTMYNKOD" v="[DATA]"/>
                        <Field r="CNVN_NVNTIMSTP" v="[DATA]"/>
                        <Field r="CNVN_FORNVN" v="[DATA]"/>
                        <Field r="CNVN_FORNVNMRK" v="[DATA]"/>
                        <Field r="CNVN_MELNVN" v="[DATA]"/>
                        <Field r="CNVN_MELNVNMRK" v="[DATA]"/>
                        <Field r="CNVN_EFTERNVN" v="[DATA]"/>
                        <Field r="CNVN_EFTERNVNMRK" v="[DATA]"/>
                        <Field r="CNVN_SLAEGTNVN" v="[DATA]"/>
                        <Field r="CNVN_SLAEGTNVNMRK" v="[DATA]"/>
                        <Field r="CNVN_STARTDATO" v="[DATA]"/>
                        <Field r="CNVN_STARTDATOUSM" v="[DATA]"/>
                        <Field r="CNVN_ADRNVNMYNKOD" v="[DATA]"/>
                        <Field r="CNVN_ADRNVNTIMSTP" v="[DATA]"/>
                        <Field r="CNVN_ADRNVN" v="[DATA]"/>
                        <Field r="CNVN_INDRAP" v="[DATA]"/>
                        <Field r="CNVN_DOKMYNKOD" v="[DATA]"/>
                        <Field r="CNVN_DOKTIMSTP" v="[DATA]"/>
                        <Field r="CNVN_DOK" v="[DATA]"/>
                        <Field r="CNVN_MYNTXTMYNKOD" v="[DATA]"/>
                        <Field r="CNVN_MYNTXTTIMSTP" v="[DATA]"/>
                        <Field r="CNVN_MYNTXT" v="[DATA]"/>
                        <Field r="HISTORIKMRK" 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>
    <Gctp v="2.0" env="Udvikling">
        <System r="CprSoeg">
            <Service r="NAVNE3">
                <CprServiceHeader r="NAVNE3" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>
  • No labels