Beskrivning

Hanterar data kopplad till personer som arbetar eller verkar inom organisationen Sundsvalls kommun eller kommunala bolag.

Detta baserat på anställning i Heroma eller att användarkonto skapats manuellt vilket är processen för externa resurser som inte är anställda. Det kan även förekomma för anställda att man får konto skapat manuellt, dels då det historiskt inte alltid skapades användarkonton för t.ex. timvikarier (vilket det gör sedan hösten 2021) men även då alla anställningsformer inte läses in i Metakatalogen och därmed inte får konto genererat.

Beroende på nyttjad end-point i Employee så skiljer sig omfattningen/datakällan åt och är enligt nedan:

Samtliga end-points i Employee, undantaget 'employee/employments' är baserade på att man har konto och kontoinformation i Metakatalogen. Kontot kan ha skapats automatiskt baserat på en viss anställning (bl.a. s.k. förmånsgrupp) i Heroma* men även manuellt.
End-pointen 'employee/employments' är däremot enbart en spegling av anställningsinformationen från Heroma*. En person kan ha flera anställningar vid en viss given tidpunkt t.ex. vara tjänstledig för studier men samtidigt arbeta extra i en annan verksamhet. Det är också vanligt att timvikarier har anställningar i flera verksamheter samtidigt.

*Heroma kommer vara det gemensamma HR systemet för kommunkoncernen, vissa av bolagen nyttjar ännu egna HR system, dessa föder också Metakatalogen på samma sätt. Planen är att alla bolag ska ha gått över till Heroma som HR system under 2022.

Livscykelstatus

Under utveckling

Lösningsbeskrivning

Hantering av personuppgifter

Uppgifter så som namn, adress, telefonnummer och e-post hanteras av API:et då det är nödvändigt för att arbetsgivaren ska kunna jobba med bland annat löneärenden, HR-ärenden eller andra ärenden mellan arbetsgivare och arbetstagare. Data används även för access till olika system som används inom organisationen.

API specifikation

Hämta information om nyanställningar

Exempelanrop:

GET

/api/1.0/employee/employments

Om anropet görs helt utan parameterar så hämtar nya/förändrade anställning från alla bolag de senaste 7 dagarna.
Parametrar skickas som en queryparameter formaterad som en JSON-sträng.

/api/1.0/employee/employments?filter={"CompanyId":1,"ShowOnlyNewEmployees":true}

Parametrar:

Parameter	Förklaring
CompanyId	Numeriskt värde (int16). 1=SK, Se FOCompany för värdelista. Kan anges som array Om denna parameter utelämnas visas alla bolag
HireDateFrom	Startintervall för anställningsdatum. Anges som helt datum utan tid. Ex:”2021-06-01”. Om denna utelämnas visas de senaste sju (7) dagarana.
HireDateTo	Slutintervall för anställningsdatum. Anges som helt datum utan tid. Ex: “2021-06-14”
IsManual	Filtrerar på “vanliga” eller “manuella” anställningar. Värdet kan vara 0/false eller 1/true Om denna är 0/false så visas bara “vanliga” anställningar. Om den är 1/true visas bara “manuella” anställningar. Om den utelämnas visas alla anställningar
ShowOnlyNewEmployees	Filtrerar ut nyanställningar. D.v.s. personer som fått sin första anställning på bolaget. Kallas ibland för “Joiners” eller “New hires”. Om värdet är 1/true så visas bara joiners Om värdet är 0/false ELLER om parametern utlämnas så vissas både joinsers och personer med förändringar i tjänstern.
PersonId	Guid som är nyckel för en person. Om denna parameter skickas in kommer enbart en (1) person att returneras.

Exempel på parametrar:

Filter (?filter=…)	Resultat
'{"CompanyId":1,"ShowOnlyNewEmployees":true}'	Visar nyanställda i bolag 1 (SK) de senaste sju dagarana
'{"CompanyId":1,"ShowOnlyNewEmployees":true,"HireDateFrom":"2021-06-01"}'	Visar nyanställda i bolag 1 från den 1/6 till dags dato
'{"CompanyId":[8,9],"ShowOnlyNewEmployees":true,"HireDateFrom":"2021-06-01"}'	Visar nyanställda i bolag 8 & 9 [8,9] från den 1/6 till dags dato
'{"CompanyId":[1,14,17],"IsManual":true,"HireDateFrom":"2021-06-05","HireDateFrom":"2021-06-10"}'	Visar nya och förändrade manuella anställningar i bolag 1,14 & 17 för peridoen 5/6-10/6
‘{“PersonId”:”C53801E1-D185-4967-92F4-EBE735DE85B7”}’	Hämtar alla anställningar för angiven person

Hämta information om avslutade anställningar

Exempelanrop:
GET

/api/1.0/employee/endedemployments

Om anropet görs helt utan parameterar så hämtas avslutade anställningar från bolag och koncern från de senaste 7 dagarna.
Parametrar skickas som en queryparameter formaterad som en JSON-sträng.

/api/1.0/employee/employments?filter={"CompanyId":1, "EventInfo":"Company"}

Parametrar:

Parameter	Förklaring
CompanyId	Numeriskt värde (int16). 1=SK, Se FOCompany för värdelista. Kan anges som array Om denna parameter utelämnas visas alla bolag
RetireDateFrom	Startintervall för avslutningsdatum. Anges som helt datum utan tid. Ex:”2021-06-01”. Om denna utelämnas visas de senaste sju (7) dagarana.
RetireDateTo	Slutintervall för avslutningsdatum. Anges som helt datum utan tid. Ex: “2021-06-14”
EventInfo	”Company” eller ”Corporate”, filtrerar ut sista anställningar på företag eller koncern. Vid ”Company” är det personer som lämnat ett företagt, men är anställd på ett eller flera av de andra bolagen. Vid ”Corporate” har personen ingen anställning kvar.
Title	Filtrerar ut avslutade anställningar på dess titel
Title	Guid som är nyckel för en person. Om denna parameter skickas in kommer enbart en (1) person att returneras.

Exempel på parametrar:

Filter (?filter=…)	Resultat
'{"CompanyId":1, "EventInfo": ”Corporate”}'	Visar avslutade anställningar i bolag 1 (SK) senaste sju dagarana. och inte har några anställningar kvar.
'{"CompanyId":1, "EventInfo": ”Corporate”, "RetireDateFrom":"2022-06-01","RetireDateTo":"2022-06-18"}'	Visar avslutade anställningar i bolag 1 och som inte har kvar någon anställning i koncernen från den 1/6 till 18/6
'{"CompanyId":[8,9],"RetireDateFrom":"2022-06-01"}'	Visar avslutade anställningar i bolag 8 & 9 [8,9] ,både personer som lämnar koncernen och de som har anställning kvar på andra bolag än det de slutade ifrån, från den 1/6 till dags dato
'{"CompanyId":[1,14,17], "EventInfo": ”Company”," RetireDateFrom":"2021-06-05","RetireDateFrom":"2021-06-10"}'	Visar avslutade anställningar i bolag 1,14 & 17 för peridoen 5/6-10/6. Samt har kvar anställning på andra bolag, än det de lämnade.
‘{“PersonId”:”C53801E1-D185-4967-92F4-EBE735DE85B7”}’	Hämtar alla avslutade anställningar för angiven person

Säkerhetsklassning

Säkerhetsklass 2

Autentiseringsmetod: Oauth2

(Ref: Säkerhetsklassning av APIer )

API-ägare

Teknisk ägare

https://sundsvall.atlassian.net/wiki/spaces/META

För tekniska frågor: joel.lindberg@sundsvall.se, marcus@xpservices.se

Länkar

<Länkar till dev-portal;

Test
Sandbox
Produktion>

FAQ

<FAQ>