FROM

Anger vilken nod som skall vara root-nod och som samtliga noder specificerade i WHERE satsen är relativa emot.

WHERE

Anger noder, operatorer och värden för sökningen

AND

Används för att sätta samma flera villkor där alla villkor måste vara uppfyllda.

^{<nod1> = '<värde>' AND <nod2> = '<värde>'}

OR

Används för att sätta samman flera villkor där ett eller flera villkor måste vara uppfyllda.
Frågor innehållande OR ska anges med parenteser.

^{(<nod1> = '<värde>' OR <nod1> = '<värde>')}

' samt "

Används för att ange ett värde. Både '-tecken och "-tecken har här samma funktion.

^{<nod1> = '<värde>' AND <nod2> = "<värde>"}

String

^{personrecord.name.givenname}

^'Anna'

Numeric

^{personrecord.addressinformation.residentialaddress.postalcode}

^'83132'

PartialDate

^{personrecord.birth.dateofbirth}

^'1912'

^'1912-12'

^'1912-12-12'

OID (IIType.root)

^{personrecord.personalidentity.root}

^{'1.2.752.129.2.1.3.1'}

^'PNR'

Kan anges som antingen det exakta OID-värdet (som då hanteras som en String), men det kan kan även anges som ett fördefinierat värde i enlighet med predefinedvalues

Boolean

^{protectedpersonindicator}

'true'

'false'

=

Alla

Anger att värdet för noden skall matchas exakt (dock case insensitive).

^{<nod> = 'daniel'}

!=

Alla

Anger att värdet för noden inte skall matcha exakt (case sensitive).

<nod> != 'kalle'

LIKE

String

PartialDate

Anger att värdet för noden innehåller 1 wildcard i form av "%" på slutet.

Används för att söka på ofullständigt värde.

^{<string nod> LIKE 'Anderss%'}

^{<partialdate nod> OBS! SE NEDAN}

IN

Alla

Anger att värdet på noden ska finnas i en specificerad värdemängd.

^{<nod> IN ('daniel','anna','noa')}

NOT IN

Alla

Anger att värdet på noden inte ska finnas i en specificerad värdemängd.

<nod> NOT IN  ('daniel', 'anna', 'noa')

BETWEEN

Numeric

Date

PartialDate

PNR, SNR (Hanteras som numeriska värden i detta fall)

Anger att värdet på noden ska finns mellan två värden.

Frågor innehållande OR ska anges med parenteser.

^{(<numeric nod> BETWEEN '132' AND '321')}

^{(<personid nod> BETWEEN '197804010000' AND '197804319999')}

^{<partialdate nod> OBS! SE NEDAN}

>

<

>=

<=

Numeric

Date

PartialDate

PNR, SNR (Hanteras som numeriska värden i detta fall)

Anger att värdet för noden ska vara:

• större än

• mindre än

• större eller lika med

• mindre eller lika med

angivet värde.

^{<numeric nod> > '321'}

^{<personid nod> > '197804000000'}

^{<date nod> <= '1983-03-04'}

^{<partialdate nod> OBS! SE NEDAN}

IS NULL

IS NOT NULL

Alla

Anger att noden måste vara satt, kontra att noden inte får vara satt.

^{<nod> IS NULL}

^{<nod> IS NOT NULL}

=

^{FROM PersonRecord WHERE personalIdentity.extension = "191212121212";}

!=

^{FROM PersonRecord WHERE personalIdentity.extension != "191212121212";}

LIKE

^{FROM PersonRecord.name WHERE givenName LIKE "Ad%";}

IN

^{FROM PersonRecord.addressInformation.residentialAddress WHERE postalCode IN ("83100","83134","83433");}

NOT IN

^{FROM PersonRecord WHERE PopulationRegistrationLocality.CountyCode NOT IN ("01","04") AND Version >= "20210929162541"}

BETWEEN

^{FROM PersonRecord.populationRegistrationLocality WHERE (populationRegistrationDate BETWEEN "1990-01-01" AND "1999-12-31");}

>

^{FROM PersonRecord.immigration WHERE immigrationDate > "1990";}

<

^{FROM PersonRecord.immigration WHERE immigrationDate < "1990";}

>=

^{FROM PersonRecord.immigration WHERE immigrationDate >= "1990";}

<=

^{FROM PersonRecord.immigration WHERE immigrationDate <= "1990";}

IS NULL

^{FROM PersonRecord WHERE name.middleName IS NULL;}

IS NOT NULL

^{FROM PersonRecord WHERE name.middleName IS NOT NULL;}

OR

^{FROM PersonRecord WHERE (personalIdentity.extension = "191212121212" OR personalIdentity.extension = "181212121212");}

AND

^{FROM PersonRecord WHERE personalIdentity.extension = "191212121212" AND gender = "1" AND includetestidentities = "true";}

OR / AND

^{FROM PersonRecord WHERE (personalIdentity.extension LIKE "19%" OR personalIdentity.extension LIKE "20%") AND gender = "1";}

=

!=

IN

NOT IN

Samtliga värden är giltiga att ange och dessa matchas exakt.

Anges exempelvis '1912-01' som värde, så ges det enbart träff på de som har exakt detta värde. Dvs träff ges ej på de med värde '1912' eller '1912-01-03'.

^{personrecord.birth.dateofbirth = '1912-01'
personRecord.birth.dateOfBirth != '1912-01'
personrecord.birth.dateofbirth IN ('1912','1913')
personrecord.birth.dateofbirth NOT IN ('1912','1913')}

LIKE

Matchar alla värden som börjar med ett visst värde. Kan exempelvis användas för att söka på alla som har 1912 som angivet år, oavsett ytterligare kvalificerare.

Sökning på "LIKE '1912%'" matchar '1912', '1912-02', '1912-03-17' o.s.v.

^{personrecord.birth.dateofbirth LIKE '1912%'}

>

<

>=

<=

BETWEEN

Sökningen matcher enbart de partialDate som har samma antal värdesiffror som anges i frågan. Om villkor ställs med ett värde innehållande YYYY, så ges enbart träff på de som har YYYY lagrat i databasen. De med värden YYYY-MM samt YYYY-MM-DD matchas inte.

Sökning på "> 1912-01" matchar alla partialDate som är lagade på formatet YYYY-MM och som har ett värde större än "1912-01".

Om man vill åstadkomma en sökning som finner alla partialDate från 1950 till 1959-12-31 oavsett vilket format de har i databasen så ställs en fråga med tre "OR" villkor.

((nod BETWEEN '1950' AND '1959') OR (nod BETWEEN '1950-01' AND '1959-12') OR (nod BETWEEN '1950-01-01' AND '1959-12-31'))

Här blir det dubbel parantes då både OR och BETWEEN operatorer ska omges av parenteser.

^{personrecord.birth.dateofbirth >= '1950-01-01'}

^{personrecord.birth.dateofbirth >= '1978'}

^{(personrecord.birth.dateofbirth BETWEEN '1950-01-01' AND '1959-12-31')}

Observera att för närvarande är inte alla noder indexerade i databasen. Detta innebär att de i praktiken inte garanterat är sökbara via synkrona anrop då resultatet kan ta för lång tid att sammanställa, och därför bör dessa noder tills vidare inte inte inkluderas i synkrona sökningar (SearchPersonsForProfile). Däremot går det bra att använda dem i asynkrona anrop (SearchPersonsForProfileByOrder). I dokumentationen nedan anges vilka som är indexerade genom att de raderna har grön bakgrundsfärg och de icke indexerade har vit bakgrundsfärg.

^{primaryidentity}

boolean

Specialnod/flagga som endast kan anges en gång i samma fråga. Noden får inte vara omgiven av parenteser.

Måste användas med andra noder dock inte bara med andra specialnoder som t.ex includeTestIdentities.

Ifall denna sätts till true kommer endast personposter som är huvudidentitet inkluderas i svaret. Sätts den till false fungerar sökningen på samma sätt som om noden inte inkluderats alls i frågan, det vill säga svaret kommer att inkludera både personposter som är huvudidentitet och sådana som ej är huvudidentitet.

Giltiga värden är true/false.

^{includetestidentities}

boolean

Specialnod/flagga som endast kan anges en gång i samma fråga. Noden får inte vara omgiven av parenteser.

Måste användas med andra noder dock inte bara med andra specialnoder som t.ex primaryIdentity.

Om satt kommer även personposter flaggade som testpersoner att sökas och inkluderas i svaret.

Giltiga värden är true/false.

^{maxResultsPerFile}

Numeric

Specialnod som endast kan anges en gång i samma fråga. Noden får inte vara omgiven av parenteser.

Måste användas med andra noder dock inte bara med andra specialnoder som t.ex primaryIdentity.

Anger ifall man önskar att sökresultatet delas upp i flera filer och i sådana fall hur många personposter som max skall läggas i varje resultatfil.

Ifall ej satt så kommer resultatet att levereras i endast en (1) fil oavsett hur stort resultatet är.

Detta värde får ej vara lägre än 500.

Har endast effekt i "ByOrder"-kontrakten.

^gender

String

Kodverk

1 för Man
2 för Kvinna

^{protectedpersonindicator}

boolean

Sekretessmarkering hos Skatteverket

^{protectedPopulationRecord}

boolean

Skyddad folkbokföring hos Skatteverket

^{personrecord.personalidentity.root}

String

OID eller fördefinierat värde för ID-typ. Se Fördefinierade värden nedan samt 4.6 Identitetsformat för möjliga värden.

^{personrecord.personalidentity.extension}

String/
Numeric

Personnummer, Samordningsnummer eller nummer för Reservidentitet.

^{personrecord.version}

Numeric

Tidsstämpel då personposten senast uppdaterades i Personuppgiftstjänstens databas.

^{personrecord.name.givenname}

String

^{personrecord.name.middlename}

String

^{personrecord.name.surname}

String

^{personrecord.birth.dateofbirth}

String/
PartialDate

Indexering av denna nod är för närvarande ej aktiv, men planeras införas hösten 2024.

SimpleQL-sökning stödjer maximalt tio tecken långt sökvärde för denna nod, dvs maximalt fullt datum såsom 2020-09-14, och inte med någon tidsangivelse till detta (någon tidsangivelse finns ej heller i data från Skatteverket).

^{personrecord.birth.placeofbirthsweden.birthcountycode}

String

^{personrecord.birth.placeofbirthsweden.birthparish}

String

^{personrecord.birth.birthabroad.placeofbirthabroad.placeofbirthabroad}

String

^{personrecord.birth.birthabroad.countryofbirth}

String

^{personrecord.populationregistrationlocality.countycode}

String

^{personrecord.populationregistrationlocality.municipalitycode}

String

^{personrecord.populationregistrationlocality.parishcode}

String

^{personrecord.populationregistrationlocality.populationregistrationdate}

String/
PartialDate

^{personrecord.addressinformation.nationalkeys.propertyid}

String

^{personrecord.addressinformation.nationalkeys.addressplaceid}

Numeric

^{personrecord.addressinformation.nationalkeys.apartmentid}

Numeric

^{personrecord.addressinformation.nationalkeysuuid.propertyid}

String

^{personrecord.addressinformation.nationalkeysuuid.addressplaceid}

String

^{personrecord.addressinformation.nationalkeysuuid.apartmentid}

String

^{personrecord.addressinformation.specialpostaladdress.postaladdress1}

String

^{personrecord.addressinformation.specialpostaladdress.postaladdress2}

String

^{personrecord.addressinformation.specialpostaladdress.careof}

String

^{personrecord.addressinformation.specialpostaladdress.postalcode}

Numeric

^{personrecord.addressinformation.specialpostaladdress.city}

String

^{personrecord.addressinformation.residentialaddress.postaladdress1}

String

^{personrecord.addressinformation.residentialaddress.postaladdress2}

String

^{personrecord.addressinformation.residentialaddress.careof}

String

^{personrecord.addressinformation.residentialaddress.postalcode}

Numeric

^{personrecord.addressinformation.residentialaddress.city}

String

^{personrecord.addressinformation.addressabroad.postaladdress1}

String

^{personrecord.addressinformation.addressabroad.postaladdress2}

String

^{personrecord.addressinformation.addressabroad.postaladdress3}

String

^{personrecord.addressinformation.addressabroad.countrycode}

String

^{personrecord.addressinformation.addressabroad.addressabroaddate}

String/
ParitalDate

^{personrecord.addressinformation.addressabroad.votingdate}

String/
PartialDate

^{personrecord.addressinformation.district.districtcode}

String

^{personrecord.contactinformation.contacttype}

String

^{personrecord.contactinformation.use}

String

^{personrecord.contactinformation.value}

String

^{personrecord.contactperson.contactrelationshiptype}

String

^{personrecord.contactperson.givenname}

String

^{personrecord.contactperson.middlename}

String

^{personrecord.contactperson.surname}

String

^{personrecord.contactperson.contactpersonaddress.postaladdress1}

String

^{personrecord.contactperson.contactpersonaddress.postaladdress2}

String

^{personrecord.contactperson.contactpersonaddress.careof}

String

^{personrecord.contactperson.contactpersonaddress.postalcode}

Numeric

^{personrecord.contactperson.contactpersonaddress.city}

String

^{personrecord.contactperson.contactpersoncontactinformation.contacttype}

String

^{personrecord.contactperson.contactpersoncontactinformation.use}

String

^{personrecord.contactperson.contactpersoncontactinformation.value}

String

^{personrecord.confirmedidentity.typeofidentification}

String

^{personrecord.confirmedidentity.identificationnumber}

String

^{personrecord.confirmedidentity.attachmentid}

String

^{personrecord.confirmedidentity.issuersofid}

String

^{personrecord.administrativeinformation.categoryofperson}

String

^{personrecord.administrativeinformation.accountcode}

String

^{personrecord.deregistration.deregistrationreasoncode}

String

Nod ej separat indexerad utan ingår i kombinerat index med personrecord.deregistration.deregistrationdate, vilket gör att indexeringen fungerar om båda dessa noder söks på i samma sökning.

^{personrecord.deregistration.deregistrationdate}

String/
PartialDate

^{personrecord.maritalstatus.maritalstatuscode}

String

^{personrecord.maritalstatus.maritalstatusdate}

String/
PartialDate

^{personrecord.immigration.immigrationdate}

String/
PartialDate

^{personrecord.immigration.immigrationidentity.personalidentitynumber}

String

^{personrecord.citizenship.citizenshipcountrycode.countrycode}

String

^{personrecord.citizenship.citizenshipdate}

String/
PartialDate

^{personrecord.citizenship.status}

String

^{personrecord.relationship.relationshipid.personalidentity.extension}

String

^{personrecord.relationship.relationshipid.dateofbirth}

PartialDate

^{personrecord.relationship.relationshiptype}

String

^{personrecord.relationship.status}

String

^{personrecord.attachment.id}

String

^{personrecord.attachment.mediatype}

String

^{personrecord.populationRegistrationRecord.historicalRecords.historicalRegistration.municipalityCode}

String

^{personrecord.populationRegistrationRecord.historicalRecords.historicalRegistration.countyCode}

String

^{personrecord.populationRegistrationRecord.historicalRecords.historicalRegistration.localRegistrationTime}

Numeric

Tidsstämpel då den historiska folkbokföringen lästes in från Navet för första gången. Finns endast på historiska poster ändrade efter februari 2019.

^{personrecord.populationRegistrationRecord.historicalRecords.historicalRegistration.localRegistrationEndTime}

Numeric

Tidsstämpel då den historiska folkbokföringen slutade att gälla till förmån för en ny historisk folkbokföringspost.
Finns endast på historiska poster ändrade efter december 2021.

^{personrecord.coordinationnumberdata.deceaseddate}

PartialDate

^{personrecord.coordinationnumberdata.renewaldate}

PartialDate

^{personrecord.coordinationnumberdata.preliminarytransferdate}

PartialDate

^{personrecord.coordinationnumberdata.allocationdate}

PartialDate

^{personrecord.personalidentitystatus.identitystatus}

String

^{personrecord.personalidentitystatus.identitystatuscause}

String

^{personrecord.personalidentitystatus.identitystatusdate}

PartialDate

PNR

Typen av identitet är personnummer.

^{'1.2.752.129.2.1.3.1'}

^{personalidentity.root = '1.2.752.129.2.1.3.1'}

^{personalidentity.root = 'PNR'}

SNR

Typen av identitet är samordningsnummer.

^{'1.2.752.129.2.1.3.3'}

^{personalidentity.root = '1.2.752.129.2.1.3.3'}

^{personalidentity.root = 'SNR'}

NRID

Typen av identitet är reserervidentitet som följer formatet för nationell reservidentitet.

^{'1.2.752.74.9.1'}

^{personalidentity.root = '1.2.752.74.9.1'}

^{personalidentity.root = 'NRID'}

LRID

Typen av identititet är lokalt reservid, men inte specifikt vilket.

^{Alla som inte är av ovan angivna värden.}

^{personalidentity.root IN ('1.1.1','2.2.2',.....)}

^{personalidentity.root = 'LRID'}