1. Indledning

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.

1.2. Adgang

1.2.1. Kundefokus

Brug af denne service henvender sig til offentlige myndigheder.

1.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 FAMILIE.

2. Søgeservice

2.1. Søgekriterier

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.

2.2. Nøgleregler

Søgningen kan fejle med en række fejlkoder, hvis de indsendte kriterier ikke accepteres af servicen.

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]

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.

3. Søgeservice svar

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

Servicen returnerer følgende felter:

Servicen returnerer følgende tabel-rækker i tabel FAMILIE:

4. GCTP Eksempler

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.

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

4.1. Søgning

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="1.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>

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="1.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="POSTNR" v="[DATA]"/>
                                <Field r="CPSN_POSTDISTTXT" v="[DATA]"/>
                            </Row>
                        </Table>
                    </Rolle>
                </CprData>
                <Kvit r="Ok" v="0"/>
            </Service>
        </System>
    </Gctp>
</root>

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="1.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>

v1.2.1