Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version 2.0.0

...

Anchor
_indledning
_indledning
1. Indledning

Info

ID: FAMILIE
Navn: Familieoplysninger
System: CprSoeg

Anchor
_formål
_formål
1.1. Formål

Servicen har til formål at vise familieoplysninger for en given person, dvs. oplysninger om personen selv, ægtefælle, partner, mor, far og børn samt markering for forældremyndighed.

Anchor
_adgang
_adgang

...

2. Adgang

Anchor
_kundefokus
_kundefokus

...

2.1. Kundefokus

Brug af denne service henvender sig til offentlige myndigheder.

Anchor
_adgangskontrol
_adgangskontrol

...

2.2. Adgangskontrol

Services er underlagt adgangsprincipper som en del af adgangskontrollen til en service[1]. Nedenstående tabel viser, hvilke adgangsprincipper der gælder for FAMILIEdenne 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.

Anchor
_

...

nøglefelter
_

...

nøglefelter

...

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.

...

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.

PNRPersonnummerJa10

Personnummer

Anchor
_nøgleregler
_nøgleregler

...

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
Der er ingen servicespecifikke nøgleregler til denne service

Fejlbesked i ovenstående er ikke den fejlbesked, der sendes i svaret. Den fejl der returneres hentes ud fra fejlkoden. Den generelle dokumentation af fejlkoder og beskeder ses her [TODO her kommer der et link til udtræk af fejlkoder fra ctkvit]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 et af servicehåndbogens bilag ang. fælles nøgleregler.

Generelle systemfejlkoder der ikke henvender sig til servicen eller dens data, findes også i servicehåndbogen i et bilag vedr. generelle fejlkoder.

...

.

Anchor
_gctp
_gctp
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.

Anchor
_gctp_eksempler
_gctp_eksempler
4.1. GCTP Eksempler

Se Appendiks.

Anchor
_søgnings_resultats_datafelter
_søgnings_resultats_datafelter

...

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, tl] tm, tl, bv). Hvis der ikke findes data til en attribut sættes attributten ikke for feltet.

...

Table 5. Felter der returneres pr. række i en tabel.
FeltFormatAttributterBeskrivelse
FAMMRKBinær markering (X)v

Familierelation til hovedpersonen

PNR-FOEDDATODatov

Personnummer/fødselsdato

ADRNVNTekstv,t

Adresseringsnavn

CBSK_TYPBeskyttelsestypev,t,ts,tm,tl

Beskyt type

CNVN_STATUSStatusv,t,ts,tm,tl

Status

STADRTekstv

Standardadresse

CPST_POSTNRPostnummerv,t

Postnummer

CPSN_POSTDISTTXTTekstv,t

Postdistrikt tekst

Anchor
_appendiks
_appendiks
5. Appendiks

Anchor
_gctp_

...

søgeservices
_gctp_

...

søgeservices

...

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 tidligere i dokumentet.

...

5.1. GCTP Søgeservices

Anchor
gctp_eksempler_appendiks
gctp_eksempler_appendiks
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 felt oversigten feltoversigten er der angivet felter der som har attributter, men helt generelt er attributter noget der kommer med ud som svar på et request

Anchor
_søgning
_søgning

...

5.1.2. Søgning

Code Block
languagexml
titleEksempel på GCTP søgning til servicen.
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="12.0" env="Udvikling">
        <System r="CprSoeg">
            <Service r="FAMILIE">
                <CprServiceHeader r="FAMILIE">
                    <Key>
                        <Field r="PNR" v="[DATA]"/>
                        <Field r="AIA" v="[DATA]"/>
                        <Field r="MAXA" v="[DATA]"/>
                        <Field r="REST" v="[DATA]"/>
                    </Key>
                </CprServiceHeader>
            </Service>
        </System>
    </Gctp>
</root>
Code Block
languagexml
titleEksempel på et GCTP svar fra servicen.
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="12.0" env="Udvikling">
        <System r="CprSoeg">
            <Service r="FAMILIE">
                <CprServiceHeader r="FAMILIE" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Field r="FORAELDREMYNMRK" v="[DATA]"/>
                        <Table r="FAMILIE">
                            <Row k="[ROW KEY]">
                                <Field r="FAMMRK" v="[DATA]"/>
                                <Field r="PNR-FOEDDATO" v="[DATA]"/>
                                <Field r="ADRNVN" v="[DATA]"/>
                                <Field r="CBSK_TYP" v="[DATA]"/>
                                <Field r="CNVN_STATUS" v="[DATA]"/>
                                <Field r="STADR" v="[DATA]"/>
                                <Field r="CPST_POSTNR" v="[DATA]"/>
                                <Field r="CPSN_POSTDISTTXT" v="[DATA]"/>
                            </Row>
                        </Table>
                    </Rolle>
                </CprData>
                <Kvit r="Ok" v="0"/>
            </Service>
        </System>
    </Gctp>
</root>
Code Block
languagexml
titleEksempel 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="12.0" env="Udvikling">
        <System r="CprSoeg">
            <Service r="FAMILIE">
                <CprServiceHeader r="FAMILIE" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>

...