Bilag - Fælles Nøgleregler

Indholdsfortegnelse

1. Indledning

Nærværende dokument beskriver hvilke fælles nøgleregler der gælder for GCTP Services - både til ajourføringer og søgninger.

2. Fælles nøgleregler for ajourførings-services

I forbindelse med at GCTP Services anvendes til at indberette data, skal den pågældende services altid initieres for at starte konversationen med servicen.

Denne initiering af servicen foretages altid ved at brugeren udfylder nogle nøgleværdier, som angiver hvilken domæne objekter der indberettes data på, f.eks. et personnummer når indberetningen vedrører en person, eller en vejkode og kommunekode når indberetningen vedrører en adresse.

Hver GCTP Service har hvert sit sæt at nøgler der tillades, men mange af disse nøgler behandles ens og der er derfor også er regelsæt for disse.

Herunder beskrives hvilke generelle regelsæt der gælder for disse fælles nøgler.

2.1. Personnummer nøgler

Disse nøgler dækker over:

  • PNR : Personnummer
  • SPNR : Sekundært personnummer, anvendes f.eks. ved vielser
  • FPNR : Far personnummer, anvendes f.eks. ved fødsel
  • MPNR : Mor personnummer, anvendes f.eks. ved fødsel

Fælles for disse er at de skal overholde formatet DDMMYYNNNN, hvor DDMMYY skal være en valid dato og NNNN være numerisk. Endvidere skal personnummeret findes i CPR systemet. Det er tilladt at anvende 0000000000 hvis personnummeret er ukendt.

Hvis en service initieres med et kendt personnummer i nøglen, og det personnummer har data i vent, udsteder systemet en advarsel. Advarslen vises kun ved første initiering, og en efterfølgende aktion i samme livscyklus session vil derfor blive godkendt.

2.2. Vejkode og Kommunekode nøgler

Disse nøgler dækker over:

  • VEJKOD : Vejkode
  • KOMKOD : Kommunekode

Begge nøgler skal være numeriske, men må gerne være foranstillet med 0.

Såfremt der indberettes data på disse nøgler, og man ikke er ved at oprette en ny kommune eller vej, skal koden findes i CPR systemet.

2.3. Myndighedsnøgler

Disse nøgler dækker over:

  • MYNKOD : Myndighedskode
  • START_MYN : Konstaterende myndighedskode
  • DOK_MYN : Verificerende myndighedskode
  • LANDEKOD : Land-myndighedskode

Disse nøgler skal være numeriske, men må gerne være foranstillet med 0.

Såfremt der indberettes data på disse nøgler og man ikke er ved at oprette en ny myndighed, skal koden findes i CPR systemet.

2.4. Vente system nøgler

Denne nøgle dækker over:

  • VNTS : Ventetimestamp

Denne nøgle skal være numerisk i form af et tidsstempel, som er udstedt af systemet i forbindelse med at data er gemt i vent. Feltet skal overholde formatet YYYYMMDDTTMISSnnnnnn, hvor YYYYMMDD er en valid dato, og TTMISSnnnnnn er et validet tidspunkt med timer, minuter, sekunder, og mikrosekunder.

3. Fælles nøgleregler for søge-services

I forbindelse med at GCTP Søgeservices anvendes til at udsøge data, skal den pågældende services altid kaldes med nogle nøgler (i søgeregi kaldet søgekriterier).

Kald af servicen foretages altid ved at brugeren udfylder nogle nøgler, f.eks. et personnummer når søgningen vedrører en person, eller en vejkode og kommunekode når søgningen vedrører en adresse.

Hver GCTP Søgeservice har et sæt af nøgler der tillades, men mange af disse nøgler behandles ens og der er derfor et fælles regelsæt for disse.

Herunder beskrives hvilke generelle regelsæt der gælder for disse fælles nøgler.

3.1. Personnummer nøgler

Denne nøgle dækker over:

  • PNR : Personnummer

Denne type nøgle skal overholde formatet DDMMYYNNNN, hvor DDMMYY skal være en valid dato, og NNNN skal være numerisk. Endvidere skal personnummeret findes i CPR systemet. Det er tilladt at anvende 0000000000 hvis personnummeret er ukendt.

3.2. UUID ident nøgle

Denne nøgle dækker over:

  • UUID : Et objekts UUID

Denne type nøgle skal overholde formatet for en UUID version 4. UUID er en international standard, og består af 32 alfanumeriske karakterer, fordelt i fem grupper, og adskilt af 4 bindestreger(-), f.eks. 8d00ef82-8aaf-458a-bbc2-232f8f989588. Endvidere skal UUID’en findes i CPR systemet.

UUID’er kan indgå i forskellige services og kan derfor referer til forskellige type af objekter, bl.a. PersonUUID eller AdresseUUID, men det ændre ikke på reglerne for denne type nøgle.

3.3. Dato nøgler

Disse nøgler dækker over:

  • VDTO : Valgdato
  • FODT : Fødselsdato
  • TDTO : Tildato
  • FDTO : Fradato
  • TDT2 : Tildato2 (anvendes ved brug af 2 sæt Til og Fra datoer)
  • FDT2 : Fradato2 (anvendes ved brug af 2 sæt Til og Fra datoer)
  • HDTO : Hændelsesdato

Fælles for disse er at disse skal overholde formatet YYYYMMDD og skal være en valid dato.

3.4. Afstemningssteds nøgle

Denne nøgle dækker over:

  • ASTD : Afstemningssted

Nøglen til et afstemningsstedet skal indeholde en af de nedenstående 4 værdier.

Table 1. Godkendte værdier for nøglen ASTD.
ASTD VærdiBeskrivelse
DKFolkeafstemning Danmark
DKFOFolkeafstemning Danmark Færøerne
DKGLFolkeafstemning Danmark Grønland
DKFOGLFolkeafstemning Danmark Færøerne Grønland

3.5. Myndigheds nøgler

Disse nøgler dækker over:

  • MYN : Myndighedskode
  • KOMK : Kommunekode
  • SOGN : Sognekode

Disse nøgler skal være numeriske, men må gerne være foranstillet med 0. Hvis nøglen indeholder en værdi, så skal koden findes i CPR systemet.

3.6. Navnesøgning nøgler

Disse nøgler dækker over:

  • NDNR : Navnedel nummer
  • NVN : Navne
  • NVNP : Navne
  • NVN1 : Navnedel 1
  • NVN2 : Navnedel 2
  • NVN3 : Navnedel 3

Nøglerne undtagen NDNR skal bestå af tegn fra Navneopslag tegnsættet som beskrevet i "Bilag - Tegnsæt".

Særlige valideringer til navnesøgning nøglerne findes beskrevet i nedenstående tabel.

NøgleBeskrivelseFejlkoder
NDNRAngiver navnedelen der skal bruges som søgekriterie til et navnesøgning, stavesøgning eller synonymsøgning. Valide værdier afhænger af servicen.
  • 3891: Valide værdier er SY1, SY2, SY3, SY4, ST1, ST2, ST3, ST4
NVN, NVNP, NVN1, NVN2, NVN3Indeholder en eller flere navnedele. Navnedelene bruges som søgekriterie til en søgning.
  • 1056: Angiv maksimalt 4 navnedele til søgningen
  • 1057: En enkelt navnedel må ikke være længere end 36 tegn
  • 2127: 1. karakter skal være et bogstav
  • 2128: Feltet skal indholde gyldige bogstaver, tal og tegn

3.7. Relation mellem nøgler

Disse nøgler dækker over:

  • KOMK : Kommunekode
  • VEJK : Vejkode

Hvis en service accepterer nøgler for både vejkoder og kommunekoder, og disse er udfyldt, skal denne kombination, der relaterer en vejkode til en kommunekode, eksistere i CPR systemet.

v1.0.6