VEJSOG2 - Sekundær vejsøgning 2

VEJSOG2 - Sekundær vejsøgning 2

Indholdsfortegnelse

1. Indledning

ID: VEJSOG2
Navn: Sekundær vejsøgning 2
System: CprSoeg

1.1. Formål

Servicen leverer en liste over veje i en given kommune eller i et givent postdistrikt.

En vej kan kun forekomme én gang medmindre vejen tilhører flere forskellige postdistrikter.

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.

KOMK

Heltal

Nej

4

Kommunekode

POST

Heltal

Nej

4

Postnummer

VTXT

Tekst

Nej

N/A

Vejkode eller vejnavn

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

816

Der skal tastes en nøgleværdi

Der skal angives en vejkode eller et vejnavntekst i VTXT-feltet.

1026

Kommune og vej eller kommune og postdistrikt passer ikke sammen

Enten KOMK eller POST skal angives.

1027

Man kan ikke angive både KOMK og POST !

Det er ikke tilladt at angive værdier for både KOMK og POST nøgler.

1044

Kombinationen af søgekriterier er ikke mulig !

Gyldige søgekriterie kombinationer:

  1. KOMKOD og VTXT

  2. POST og VTXT

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