PersonsokningSvar.xsd

Här beskrivs elementen i schemat PersonsokningFraga.xsd som används vid personsök pgm-pgm.

Termbeskrivning av XML-element

Identifieringsinformation

Identifierar frågeställaren. Termbeskrivning finns i menyn under fliken Identifieringsinformation - ws

PersonsokningFraga

PersonsokningFraga innehåller ett så kallat XML choice. Sökningen ska göras antingen på IdNummer eller på ett urval av de resterande nedanstående element. Sökning sker även på historikuppgifter (3 år). Svar levereras i form av noll till flera aviseringsposter, se innehåll och dess termbeskrivningar på sidan som beskriver AviseringPost. Är frågan felaktigt ställd levereras istället ett felmeddelande. Se termbeskrivningar för felmeddelandet på sidan som beskriver Fel.

IdNummer
Förklaring Person-, samordnings- eller immunitetsnummer
Restriktioner Måste uppfylla krav enligt den regex som återfinns i schemat samt övriga regler för personnummer eller samordningsnummer.
Obligatorisk Ingår i ett XML choice. Obligatorisk om IdNummer är valet.
Format Sträng. 12 tecken (ÅÅÅÅMMDDNNNN)
Begränsningar Kan inte kombineras med resterande nedanstående element.
FonetiskSokning
Förklaring Anger om sökning i följande tre namntermer ska ske fonetiskt. Dvs. anger om sökning på namn ska matcha stavningen i sökargumentet eller om namn med liknande uttal också ska ge träff.

Fonetisk sökning i SPAR innebär i korthet att punkt, kolon, bindestreck och kommatecken tas bort, dubbla bokstäver blir enkelbokstäver och olika bokstavskombinationer hanteras utgående från ”ljudbilder”.
Obligatorisk Nej
Format Sträng. Möjliga värden är “JA” eller “NEJ”
NamnSokArgument
Förklaring Sökargument där förnamn, mellannamn och efternamn, åtskilda av mellanslag, förekommer i godtycklig ordning. Tillåter wild card (*) i varje namn. Följande term är ett sammanslaget namnargument.
Begränsningar Får ej kombineras med FornamnSokArgument eller MellanEfternamnSokArgument.
Obligatorisk Ingår i ett XML choice. Välj antingen elementet NamnSokArgument eller FornamnSokArgument och/eller MellanEfternamnSokArgument.
Format Sträng. 1-80 tecken
FornamnSokArgument
Förklaring Sökargument där förnamn, åtskilda av mellanslag, förekommer i godtycklig ordning. Tillåter wild card (*) i varje namn.
Begränsningar Får ej kombineras med NamnSokArgument. Om NamnSokArgument inte anges måste FornamnSokArgument och/eller MellanEfternamnSokArgument anges.
Obligatorisk Ingår i ett XML choice. Välj antingen elementet NamnSokArgument eller FornamnSokArgument och/eller MellanEfternamnSokArgument.
Format Sträng. 1-80 tecken
MellanEfternamnSokArgument
Förklaring Sökargument där mellannamn och efternamn, åtskilda av mellanslag, förekommer i godtycklig ordning. Tillåter wild card (*) i varje namn.
Begränsningar Får ej kombineras med NamnSokArgument. Om NamnSokArgument inte anges måste FornamnSokArgument och/eller MellanEfternamnSokArgument anges.
Obligatorisk Ingår i ett XML choice. Välj antingen elementet NamnSokArgument eller FornamnSokArgument och/eller MellanEfternamnSokArgument.
Format Sträng. 1-60 tecken
UtdelningsadressSokArgument
Förklaring Sökargument med gatuadress eller motsvarande åtskilda av mellanslag. Tillåter wild card (*) i varje sökord. Sökning sker på adresselementen careof och utdelningsadress 1 och 2 för folkbokföringsadress och särskild postadress. Notera speciellt att man inte specifikt kan ange t.ex. gatunummer. Exempel: ett sökord 12 kan ge träff på såväl gatunummer, antal trappor, postlådenummer som boxnummer 12.
Obligatorisk Nej
Format Sträng. 1-100 tecken
PostortSokArgument
Förklaring Sökargument med postort. Tillåter ett eller flera argument åtskilda av mellanslag. Tillåter wild card (*) i varje namn.
Obligatorisk Nej
Format Sträng- 1-27 tecken
PostNr
Förklaring Postnummer.
Restriktioner Ska även matcha den regex som finns beskriven i schemat samt övriga regler för ett svenskt postnummer.
Begränsningar Får ej kombineras med PostNrFrom eller PostNrTom.
Obligatorisk Nej
Format Sträng. 1-5 tecken.
PostNrFrom
Förklaring Postnummer från och med.
Restriktioner Ska även matcha den regex som finns beskriven i schemat samt övriga regler för ett svenskt postnummer
Begränsningar Får ej kombineras med PostNr. Måste kombineras med PostNrTom.
Obligatorisk Nej. Ingår i ett XML choice.
Format Sträng. 1-5 tecken.
PostNrTom
Förklaring Postnummer till och med.
Restriktioner Ska även matcha den regex som finns beskriven i schemat samt övriga regler för ett svenskt postnummer
Begränsningar Får ej kombineras med PostNr. Måste kombineras med PostNrFrom.
Obligatorisk Nej. Ingår i ett XML choice.
Format Sträng. 1-5 tecken.
Fodelsedatum
Förklaring Sökargument för födelsedatum.
Begränsningar Får ej kombineras med FodelsedatumFrom eller FodelsedatumTom .
Obligatorisk Nej
Format Datum. (ÅÅÅÅ-MM-DD)
FodelsedatumFrom
Förklaring Födelsedatum från och med. Ger möjlighet att söka på ett födelsedatumintervall.
Begränsningar Får ej kombineras med Fodelsedatum. Måste kombineras med FodelsedatumTom.
Obligatorisk Nej
Format Datum. (ÅÅÅÅ-MM-DD)
FodelsedatumTom
Förklaring Födelsedatum till och med. Ger möjlighet att söka på ett födelsedatumintervall.
Begränsningar Får ej kombineras med Fodelsedatum. Måste kombineras med FodelsedatumFrom.
Obligatorisk Nej
Format Datum. (ÅÅÅÅ-MM-DD)
Kon
Förklaring Sökargument för kön. Om inget anges avses både man och kvinna.
Obligatorisk Nej
Format Sträng. Möjliga värden är “KVINNA” eller “MAN”
LanKod
Förklaring Länskod, avser folkbokförd i län.
Obligatorisk Nej
Format Sträng. Två (2) numeriska tecken.
KommunKod
Förklaring Kommunkod, avser folkbokförd i kommun.
Obligatorisk Nej
Format Sträng. Två (2) numeriska tecken.
DistriktKod
Förklaring Kod för distrikt.
Begränsningar Får ej kombineras med DistriktKodFrom eller DistriktKodTill.
Obligatorisk Nej
Format Sträng. Sex (6) numeriska tecken.
DistriktKodFrom
Förklaring Kod för distrikt från och med. Ger möjlighet att söka på ett distriktskodsintervall.
Begränsningar Måste kombineras med DistriktKodTill. Får ej kombineras med DistriktKod.
Obligatorisk Nej
Format Sträng. Sex (6) numeriska tecken.
DistriktKodTill
Förklaring Kod för distrikt till och med. Ger möjlighet att söka på ett distriktskodsintervall.
Begränsningar Måste kombineras med DistriktKodFrom. Får ej kombineras med DistriktKod.
Obligatorisk Nej
Format Sträng. Sex (6) numeriska tecken.