Citizen
- Jakob Melander
Analytics
Beskrivning
API för medborgarrelaterat data kopplat till 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. Personer med skyddade uppgifter kan inte hämtas ut via detta API.
API specifikation
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)
Tänk på att hämtning från Skatteverket sker på tisdagar. Om anropet görs på en måndag så finns ingen data för tiden tisdag-måndag.
Exempel:
2021-08-31 är en tisdag och då har data uppdaterats från Skatteverket.
Om vi på måndag veckan efter (2021-09-06) frågar efter alla som flyttar från 2021-08-30 så kommer vi bara att få tillbaka de som flyttat fram till 2021-08-31. Resten av datat har vi inte fått ännu.
Om vi på tisdag (2021-09-07) ställer frågan, så får vi alla som flyttat från 2021-08-30 fram t.o.m. 2021-09-07 eftersom att data hämtats den dagen.
Säkerhetsklassning
Säkerhetsklass 2
Autentiseringsmetod: Oauth2
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/META
För tekniska frågor:
Källkod
<TBD>