VEJSOG - Sekundær vejsøgning

Indholdsfortegnelse

1. Indledning

ID: VEJSOG
Navn: Sekundær vejsøgning
System: CprSoeg

1.1. Formål

Viser en liste over veje i en given kommune eller i et givent postnummer.

Bemærk at samme vejnavn og vejkode kan forekomme flere gange.

2. Adgang

2.1. Kundefokus

Brug af denne service henvender sig til:

  • offentlige myndigheder
  • private virksomheder

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

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

KOMKHeltalNej4

Kommunekode

KOMKODHeltalNej4

Kommunekode

Alternativt nøglefelt til KOMK-nøglefeltet. Bemærk at dette nøglefelt udfases på sigt.

POSTHeltalNej4

Postnummer

VTXTTekstNejN/A

Vejkode eller vejnavn

HSTVBinær markering (0/1)Nej1

Inkluder historiske veje

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
816Der skal tastes en nøgleværdi

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

1026Kommune og vej eller kommune og postdistrikt passer ikke sammen

Enten KOMK eller POST skal angives.

1027Man kan ikke angive både KOMK og POST !

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

1028Kombinationen af søgekriterier er ikke mulig !

Gyldige søgekriterie kombinationer:

  1. KOMKOD og VTXT
  2. KOMKOD, VTXT og HSTV
  3. 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]".

De felter, der er udeladt i disse eksempler, er beskrevet i deres respektive afsnit i dette dokumentet.

4.1. GCTP Eksempler

Se Appendiks.

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

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

Table 4. Felter der returneres pr. række i en tabel.
FeltFormatAttributterBeskrivelse
KOMKODKommunekodev,t,tl

Kommunekode

VEJKODNumeriskv,t,tm

Vejkode

STARTDATODatov

Startdato

TIMSTPTidstempelv

Ajourføringsdato

CPSN_POSTDISTTXTTekstv,t

Postdistrikt tekst

TABMRKNumeriskv

Angiver om vejen er aktuel (1) eller historisk (2)

5. Appendiks

5.1. GCTP Søgeservices

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

5.1.2. Søgning

Eksempel på GCTP søgning til servicen.
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="2.0">
        <System r="CprSoeg">
            <Service r="VEJSOG">
                <CprServiceHeader r="VEJSOG">
                    <Key>
                        <Field r="KOMK" v="[DATA]"/>
                        <Field r="KOMKOD" v="[DATA]"/>
                        <Field r="POST" v="[DATA]"/>
                        <Field r="VTXT" v="[DATA]"/>
                        <Field r="HSTV" v="[DATA]"/>
                        <Field r="AIA" v="[DATA]"/>
                        <Field r="MAXA" v="[DATA]"/>
                        <Field r="REST" v="[DATA]"/>
                    </Key>
                </CprServiceHeader>
            </Service>
        </System>
    </Gctp>
</root>
Eksempel på et GCTP svar fra servicen.
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<root xmlns="http://www.cpr.dk">
    <Gctp v="2.0">
        <System r="CprSoeg">
            <Service r="VEJSOG">
                <CprServiceHeader r="VEJSOG" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="VEJSOEG">
                            <Row k="[ROW KEY]">
                                <Field r="KOMKOD" v="[DATA]"/>
                                <Field r="VEJKOD" v="[DATA]"/>
                                <Field r="STARTDATO" v="[DATA]"/>
                                <Field r="TIMSTP" v="[DATA]"/>
                                <Field r="CPSN_POSTDISTTXT" v="[DATA]"/>
                                <Field r="TABMRK" v="[DATA]"/>
                            </Row>
                        </Table>
                    </Rolle>
                </CprData>
                <Kvit r="Ok" v="0"/>
            </Service>
        </System>
    </Gctp>
</root>
Eksempel 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="2.0">
        <System r="CprSoeg">
            <Service r="VEJSOG">
                <CprServiceHeader r="VEJSOG" ts="20220830222305987643"/>
                <Kvit r="Fejl" t="[FEJLTEKST TIL FEJLKODE 42]" v="42"/>
            </Service>
        </System>
    </Gctp>
</root>