CIVIL1 - Tidligere civilstande

CIVIL1 - Tidligere civilstande

Indholdsfortegnelse

1. Indledning

ID: CIVIL1
Navn: Tidligere civilstande
System: CprSoeg

1.1. Formål

Denne søgeservice giver en liste over samtlige civilstandsrækker for en person inkl. eller ekskl. de R/F-markerede rækker.

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

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

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.

PNR

Personnummer

Ja

10

Personnummer

AKX

Binær markering

Nej

1

Annulleret/korrigeret markering. Angiver om rækker med 'annulleret' og 'korrigeret' markering skal medtages.

Bemærk at MAXA nøgleværdien i denne service er altid mindst 10.

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

Fejlkode

Fejlbesked

Beskrivelse

Der er ingen servicespecifikke nøgleregler til denne service

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]".