Indholdsfortegnelse

1. Indledning

ID: VEJSOG3
Navn: Vejsøgning
System: CprSoeg

1.1. Formål

Denne service finder veje på baggrund af diverse søgekriterier.

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.

Table 2. Nøglefelter.

Felt	Format	Krævet	Feltlængde (v)	Beskrivelse
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.
AKX	Binær markering	Nej	1	Ret-/fortryd-markering
NOBR	Binær markering	Nej	1	Ingen break rækker ønskes
KOMK	Heltal	Nej	4	Kommunekode
POST	Heltal	Nej	4	Postnummer
SOGN	Heltal	Nej	4	Sogn
BYNV	Tekst	Nej	N/A	Bynavn
DKOM	Heltal	Nej	4	Distkommunekode
DSTP	Tekst	Nej	2	Distriktstype
DTXT	Tekst	Nej	N/A	Distriktstekst
HSTV	Binær markering (0/1)	Nej	1	Historiske veje
VTXF	Tekst	Nej	N/A	Vejnavn Fra eller vejkode
VTXT	Tekst	Nej	N/A	Vejnavn Til

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
817	Der skal tastes mindst 1. bogstav af vejnavn	Validerer at der er tastet mindt et bogstav hvis vejtekstFra og ellser vejtekstTil ikke er numerisk.
1026	Kommune og vej eller kommune og postdistrikt passer ikke sammen	Validerer at mindst et af felterne Kommunekode, postdistrikt, sogn og bynavn er udfyldt.
1044	Kombinationen af søgekriterier er ikke mulig !	Validerer at kombinationen af nøglefelter er valid
2567	For den valgte distrikttype skal koden være numerisk.	Validerer at distriktstekst (DTXT) er mumerisk i relation til nogle distriktstyper
2646	Der er tastet for mange cifre til den valgte distrikttype.	Validerer at distriktstekst (DTXT) ikke er for stor i relation til distriktstype

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 VEJSOG:

Table 4. Felter der returneres pr. række i en tabel.

Felt	Format	Attributter	Beskrivelse
KOMKOD	Kommunekode	v,t,tl	Kommunekode
VEJKOD	Numerisk	v,t,tl	Vejkode
VEJADRNVN	Tekst	v	Vejadresseringsnavn
CPSN_POSTDISTTXT	Tekst	v,t	Postdistrikt tekst
CVEJ_STARTDATO	Dato	V	Startdato
CVEJA_SLUTDATO	Dato	V	Slutdato
CVEJH_AKM	Ret/fortryd markering	v,t	Ret/fortryd markering
AKTMRK	Binær markering (X)	V	Angiver om vejen er aktuel
HISMRK	Binær markering (X)	V	Angiver om vejen er historisk
ARKIVMRK	null	V	Benyttes ikke
CVEJ_TIMSTP	Timestamp	V	Timestamp

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

Table 5. Felter der returneres pr. række i en tabel.

Felt	Format	Attributter	Beskrivelse
KOMKOD	Kommunekode	v,t,tl	Kommunekode

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="VEJSOG3">
                <CprServiceHeader r="VEJSOG3">
                    <Key>
                        <Field r="AKX" v="[DATA]"/>
                        <Field r="NOBR" v="[DATA]"/>
                        <Field r="KOMK" v="[DATA]"/>
                        <Field r="POST" v="[DATA]"/>
                        <Field r="SOGN" v="[DATA]"/>
                        <Field r="BYNV" v="[DATA]"/>
                        <Field r="DKOM" v="[DATA]"/>
                        <Field r="DSTP" v="[DATA]"/>
                        <Field r="DTXT" v="[DATA]"/>
                        <Field r="HSTV" v="[DATA]"/>
                        <Field r="VTXF" v="[DATA]"/>
                        <Field r="VTXT" 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="VEJSOG3">
                <CprServiceHeader r="VEJSOG3" ts="20220830222305987643"/>
                <CprData u="O">
                    <Rolle r="HovedRolle">
                        <Table r="VEJSOG">
                            <Row k="[ROW KEY]">
                                <Field r="KOMKOD" v="[DATA]"/>
                            </Row>
                        </Table>
                    </Rolle>
                </CprData>
                <Kvit r="Ok" v="0"/>
            </Service>
        </System>
    </Gctp>
</root>