KODTXT2 - Oversættelse af koder. Sorteret i tekst orden
Indholdsfortegnelse
1. Indledning
ID: KODTXT2
Navn: Oversættelse af koder. Sorteret i tekst orden
System: CprSoeg
1.1. Formål
Denne service oversætter koder til tekst.
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 |
|---|---|
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.
Kodetype kan være en af følgende værdier:
ANNKOR, BEFOLKKOD, BOLIGTYPKOD, BYFORNYKOD, CIVST, FKIRK,
KOMFORHKOD, EUMRK, KOEN, HÆNDELSE, C90HÆNDELSE, DNKHÆNDELSE,
GEJSTLIG, STED, BESKYT_TYP, EVAKUERKOD, KOMFORHTYP, ADRTXT_TYP,
MYNTYP, MYNGRP, STATUS, UMYN_RELTYP, VALG_KOD, VALGKOD, CIV_GRUND_KOD,
FLYTPB_GRUND_KOD, MOR_GRUND_KOD, FAR_GRUND_KOD, FAR_FM_GRUND_KOD,
MOR_FM_GRUND_KOD, NVN_GRUND_KOD, START_GRUND_KOD, SLUT_GRUND_KOD,
STAT_GRUND_KOD, UMYN_GRUND_KOD, VALG_GRUND_KOD, FKIRK_GRUND_KOD
Table 2. Nøglefelter.
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. |
REST | Tekst | Nej | N/A | Restart nøgle. |
KTYN | Tekst | Ja | N/A | Kodetype |
KTTY | Heltal | Ja | N/A | Kodetekst |
KODE | Tekst | Nej | N/A | Kodeværdi |
KODT | Tekst | Nej | N/A | Søgningen starter fra denne værdi |
AKTK | Tekst | Nej | N/A | Aktionskode |
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 |
|---|---|---|
749 | Angiv korrekt kode | Der fandtes ingen forekomster for søgningen. |
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: