Citizen V2
- Publisher User Atlassian Cloud
Beskrivning
API för medborgarrelaterat data kopplat till Metakatalogen.
Citizen innehåller information från Skatteverket (Navet) och uppdateringar sker dagligen.
Uppdateringar från v1
Citizen v2 är en uppdaterad version som slagit ihop 3st apier: Citizen, CitizenMapping och Person.
Person API:et låg under Citizen wso2 men dess endpoints är omdöpta och ligger nu under Citizen på riktigt.
Citizens endpoints /{personID} och /extended/{personID} har slagits ihop. Endpointen leverar samma information som gamla extended med parameter "Verbose". Dessutom inkluderar den även information om en persons sekretessstatus. För att ytterligare anpassa sökningen erbjuder den en parameter som gör det möjligt att inkludera sekretessmarkerade personer i resultatet. Det är dock viktigt att notera att sökning med filter för sekretessmarkerade personer endast kan genomföras av en behörig användare och applikation i WSO2, där åtkomsten styrs strikt av en specifik tabell i Metakatalogen.
Livscykelstatus
Produktion
Lösningsbeskrivning
Hantering av personuppgifter
Personnummer samt adresser hanteras. Detta API ska hantera och förse övriga API:er med nödvändig information om medborgare i eller kopplade till Sundsvalls kommun.
API specifikation
Information om person
Get
/{personID}
/{PersonID}?ShowClassified=true
Visar information och adresser för vald person.
Används ShowClassified=true så är det även möjligt att söka och få information om personer som är sekretessmarkerade och/eller har skyddad folkbokföring. För att kunna göra den utökade sökningen behöver anropet ske genom API GW med användare för en applikation som är behörig enligt en tabell i Metakatalogen. Går autentiseringen inte igenom ges resultatkod 401 tillbaka oavsett person som sökes.
Hämta personer som flyttat
GET
Exempelanrop:
/citizen/changedaddress?changedDateFrom=2021-09-03
Returnerar alla personer som flyttat inom eller från kommunen. Personer som flyttat till kommunen visas ej.
Parametern changedDateFrom anger det datum från vilket utsökning skall ske. Alla som flyttat fr.o.m. det datumet fram till senast inlästa datum visas. Formatet på datumet måste vara YYYY-MM-DD.
Datumet kan inte sträcka sig längre än 30 dagar bakåt i tiden.
Notera att om det skett flera flyttar för en person under perioden så visas endast information om senaste flytten i svaret (vill man se om det finns fler flyttar får man söka på nytt där datumintervaller utesluter datum för senaste flytt i första svaret).
API’et ger ingen information om ny adress med mindre än att man också flyttat. Dvs om en person får t.ex. nytt postnummer eller gatuadress räknas det inte som flytt. Undantaget är flytt mellan lägenheter i samma trapphus som per definition är samma adress men då har man ändå bytt bostad.
Svar:
Personer returneras som en array. Vid utsökning på mer än 7 dagar kan man räkna med att svaret innehåller 1000+ personer.
För varje person visas två adresser. Den aktuella (nya) och den föregående.
Status:Current = Aktuell adress (kan vara en adress inom eller utanför kommunen)Previous = Förgående adress (kommer alltid att vara en adress inom kommunen)
För att identifiera om personen lämnat kommuen bör “county” och “municipality” användas. För Sundsvalls kommun ska dessa vara county=22 & municipality=81.
Om personen utvandrat, visas dessa fält på personnivå: "unRegCode": "UV", "unRegDate": "2021-08-31T00:00:00”
På addresnivå visas detta: "status": "Current", "nrDate": "2021-08-31T00:00:00", "country": "SPANIEN", "addressType": "FOREIGN_ADDRESS"
För adresser inom kommunen visas koordinater enligt vår internkarta.
Om personen är vårdnadshavare för barn om är elever i grundskolan/gymansiet så visas dessa i arrayen custodianFor.
Om personen själv är elev så visas detta på personnivå:"typeOfSchool": "GY", (GY/GR)
Säkerhetsklassning
Säkerhetsklass 2
Autentiseringsmetod: Oauth2
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/META
För tekniska frågor:
Källkod
<TBD>