Page History: Persona API kasutusjuhend
Compare Page Revisions
Page Revision: 23/08/2021 11:45
Persona API võimaldab RESTful veebiteenuste abil Personast andmeid pärida.
Vaikimisi väljastab API andmeid JSON kujul.
Uuenduste nimekiri
Siia lisatakse jooksvalt infot API muudatuste kohta.
15.08.2021
- Breaking changes. Persona API veebiteenused /yksused ja /isikud nõuvad edaspidi täiendavaid kasutajaõiguseid, mida saab seadistada Persona kasutajaliideses Rollide alt, plokis API. Muudatus ei puuduta aruandeid.
- Lisatud uued otspunktid /tootajad, /toosuhted, /puhkused. Kirjeldused asuvad allpool. Eesmärk on vähendada vajadust kasutada tavaaruandeid, kuna neid pole väga hea masinaga lugeda.
Alustamine
API testimiseks sobib näiteks
PostmanTingimused
API kasutamiseks on vajalik Persona kasutajakonto.
Struktuuriüksuste ja projektide õiguseid saab Personas seadistada
Avaleht -> Seaded -> Kasutajad
API otspunktide ja aruannete õiguseid saab Personas seadistada
Avaleht -> Seaded -> Rollid
Authorization
Persona API kasutab
Basic Authentication-it
TYPE: Basic Auth
Username: Persona_kasutajanimi
Password: Persona_salasõna
Headers (Optional)
Kui Persona kasutajakontol on ligipääs mitmele asutusele, siis tuleb päringule kaasa anda ka header
x-asutus, mille väärtus on konkreetse asutuse 4-täheline kood. Võimalikud asutuste koodid on nähtaval veateates, mille Persona API sellisel juhul tagastab.
Isikud
Tulemusse tulevad kõik isikud, kellel on etteantud kuupäevade vahemikus vähemalt üks aktiivne ametikoht. Kasutaja näeb ainult neid isikuid, kes asuvad talle nähtavates struktuuriüksustes.
Parameetrid:
- yksused : Struktuuriüksuste Id-d, eraldatud komadega. Võimalikud struktuuriüksuste Id-d saab kätte API otspunktist /yksused. Võib jätta tühjaks.
- alates : Ametikoha alguskuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 0001-01-01. Võib jätta tühjaks.
- kuni : Ametikoha lõppkuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 9999-12-31. Võib jätta tühjaks.
Parameetrite kasutamine:
.../api/isikud?alates=2020-01-01
.../api/isikud?kuni=2020-01-31
.../api/isikud?alates=2020-01-01&kuni=2020-01-31
.../api/isikud?yksused=4686,4688,4701&alates=2020-01-01&kuni=2020-01-31
Näidisvastus:
[
{
"Id": 23788,
"Eesnimi": "Ervin",
"Perekonnanimi": "Tamm",
"Isikukood": "35701134235",
"ValismaaIsikukood": "",
"KodakondsusKl": "YlRiik|EST|1",
"SynniKp": "1957-01-13T00:00:00",
"SuguKl": "IsSugu|Mees|1",
"TootajaNr": "1001"
},
{
"Id": 21008,
"Eesnimi": "Tiina",
"Perekonnanimi": "Sarapuu",
"Isikukood": "48306125616",
"ValismaaIsikukood": "",
"KodakondsusKl": "YlRiik|EST|1",
"SynniKp": "1983-06-12T00:00:00",
"SuguKl": "IsSugu|Naine|1",
"TootajaNr": "1002"
}
]
Struktuuriüksused
Tulemusse tulevad kõik struktuuriüksused, mis on aktiivsed etteantud kuupäevade vahemikus.
Parameetrid:
- alates : Struktuuriüksuse loomiskuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 0001-01-01. Võib jätta tühjaks.
- kuni : Struktuuriüksuse likvideerimiskuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 9999-12-31. Võib jätta tühjaks.
Parameetrite kasutamine:
.../api/yksused?alates=2020-01-01
.../api/yksused?kuni=2020-01-31
.../api/yksused?alates=2020-01-01&kuni=2020-01-31
Näidisvastus:
[
{
"Id": 4686,
"YlemYksusId": null,
"Nimi": "Morna Linnavalitsus",
"KehtibAlates": "1993-01-01T00:00:00",
"KehtibKuni": null,
"Registrikood": "12345678",
"Aadress": "Pikk tn 13, Morna linn, Järva maakond",
"JuhtIsikId": 23788
},
{
"Id": 4688,
"YlemYksusId": 4686,
"Nimi": "Kantselei",
"KehtibAlates": "1993-01-01T00:00:00",
"KehtibKuni": null,
"Registrikood": "",
"Aadress": "",
"JuhtIsikId": null
},
{
"Id": 4701,
"YlemYksusId": 4686,
"Nimi": "Rahandusosakond",
"KehtibAlates": "1993-03-01T00:00:00",
"KehtibKuni": null,
"Registrikood": "",
"Aadress": "",
"JuhtIsikId": null
}
]
Töötajad
Tulemusse tulevad kõik töötajad, kellel on etteantud kuupäevade vahemikus vähemalt üks aktiivne ametikoht. Kasutaja näeb ainult neid töötajaid, kes asuvad talle nähtavates struktuuriüksustes.
Parameetrid:
- yksused : Struktuuriüksuste Id-d, eraldatud komadega. Võimalikud struktuuriüksuste Id-d saab kätte API otspunktist /yksused. Võib jätta tühjaks.
- alates : Ametikoha alguskuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 0001-01-01. Võib jätta tühjaks.
- kuni : Ametikoha lõppkuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 9999-12-31. Võib jätta tühjaks.
Parameetrite kasutamine:
.../api/tootajad?alates=2020-01-01
.../api/tootajad?kuni=2020-01-31
.../api/tootajad?alates=2020-01-01&kuni=2020-01-31
.../api/tootajad?yksused=4686,4688,4701&alates=2020-01-01&kuni=2020-01-31
Näidisvastus:
[
{
"IsikId": 23788,
"Eesnimi": "Ervin",
"Perekonnanimi": "Tamm",
"Isikukood": "35701134235",
"ValismaaIsikukood": "",
"KodakondsusKl": {
"Kood": "YlRiik|EST|1",
"Nimetus": "Eesti"
},
"SynniKp": "1957-01-13T00:00:00",
"SuguKl": {
"Kood": "IsSugu|Mees|1",
"Nimetus": "Mees"
},
"TootajaNr": "1001"
},
{
"IsikId": 21008,
"Eesnimi": "Tiina",
"Perekonnanimi": "Sarapuu",
"Isikukood": "48306125616",
"ValismaaIsikukood": "",
"KodakondsusKl": {
"Kood": "YlRiik|EST|1",
"Nimetus": "Eesti"
},
"SynniKp": "1983-06-12T00:00:00",
"SuguKl": {
"Kood": "IsSugu|Naine|1",
"Nimetus": "Naine"
},
"TootajaNr": "1002"
}
]
Töösuhted
Tulemusse tulevad kõik töösuhted, mis kehtivad etteantud kuupäevade vahemikus. Kasutaja näeb ainult neid töösuhteid, mis asuvad talle nähtavates struktuuriüksustes.
Parameetrid:
- alates : Töösuhte alguskuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 0001-01-01. Võib jätta tühjaks.
- kuni : Töösuhte lõppkuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 9999-12-31. Võib jätta tühjaks.
- toosuhe_tyyp : Töösuhte tüübid, eraldatud komadega. Formaat on 'Kood|LisaId'. Näiteks: Pohitookoht|1, Taiendav|1, Kasundusleping|1 jne. Püstkriips '|' ehk pipe on enkodeeritult '%7C'.
Parameetrite kasutamine:
.../api/toosuhted?alates=2020-01-01
.../api/toosuhted?kuni=2020-01-31
.../api/toosuhted?alates=2020-01-01&kuni=2020-01-31
.../api/toosuhted?toosuhe_tyyp=Pohitookoht|1,Taiendav|1,Kasundusleping|1
.../api/toosuhted?toosuhe_tyyp=Pohitookoht%7C1,Taiendav%7C1,Kasundusleping%7C1
Näidisvastus:
[
{
"Id": 2342,
"IsikId": 1664,
"Ametikoht": {
"Id": 532,
"Nimetus": "Autojuht"
},
"Yksus": {
"Id": 4701,
"Nimetus": "Haldusosakond"
},
"AsukohtStruktuuris": [
"Tore Firma OÜ",
"Haldusosakond"
],
"ToosuhteTyypKl": {
"Kood": "TsToosuhteTyyp|Pohitookoht|1",
"Nimetus": "Põhiametikoht"
},
"LepingNr": "TL-5/2020",
"KehtibAlates": "2020-01-04T00:00:00",
"KehtibKuni": null,
"Koormus": 0.7
},
{
"Id": 4005,
"IsikId": 1803,
"Ametikoht": {
"Id": 1201,
"Nimetus": "Kasutajatoe spetsialist"
},
"Yksus": {
"Id": 5679,
"Nimetus": "Kasutajatugi"
},
"AsukohtStruktuuris": [
"Tore Firma OÜ",
"IT osakond",
"Kasutajatugi"
],
"ToosuhteTyypKl": {
"Kood": "TsToosuhteTyyp|Pohitookoht|1",
"Nimetus": "Põhiametikoht"
},
"LepingNr": "TL-23/2021",
"KehtibAlates": "2021-02-08T00:00:00",
"KehtibKuni": null,
"Koormus": 1.0
}
]
Puhkused ja töökatkestused
Tulemusse tulevad kõik puhkused ja töökatkestused, mis kattuvad kas osaliselt või täielikult etteantud kuupäevade vahemikuga. Kasutaja näeb ainult neid kirjeid, mis kuuluvad isikutele, kes asuvad talle nähtavates struktuuriüksustes.
Parameetrid:
- alates : Puhkuse alguskuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 0001-01-01. Võib jätta tühjaks.
- kuni : Puhkuse lõppkuupäev, ISO 8601 formaadis 'YYYY-MM-DD'. Vaikimisi väärtus 9999-12-31. Võib jätta tühjaks.
- puhkus_liik : Puhkuste liigid, eraldatud komadega. Formaat on 'Kood|LisaId'. Näiteks: Pohipuhkus|1, Haigusleht|1, Lapsepuhkus|1 jne. Püstkriips '|' ehk pipe on enkodeeritult '%7C'.
Parameetrite kasutamine:
.../api/puhkused?alates=2020-01-01
.../api/puhkused?kuni=2020-01-31
.../api/puhkused?alates=2020-01-01&kuni=2020-01-31
.../api/puhkused?puhkus_liik=Pohipuhkus|1,Haigusleht|1,Lapsepuhkus|1
.../api/puhkused?puhkus_liik=Pohipuhkus%7C1,Haigusleht%7C1,Lapsepuhkus%7C1
Näidisvastus:
[
{
"Id": 97258,
"IsikId": 16284,
"ToosuheId": 24123,
"PuhkusLiikKl": {
"Kood": "TsPuhkusLiik|Pohipuhkus|1",
"Nimetus": "Põhipuhkus 28"
},
"KehtibAlates": "2021-07-05T00:00:00",
"KehtibKuni": "2021-07-25T00:00:00",
"OnKinnitatud": true
},
{
"Id": 97274,
"IsikId": 16284,
"ToosuheId": 24123,
"PuhkusLiikKl": {
"Kood": "TsPuhkusLiik|Haigusleht|1",
"Nimetus": "Haigusleht"
},
"KehtibAlates": "2021-07-28T00:00:00",
"KehtibKuni": "2021-07-30T00:00:00",
"OnKinnitatud": true
},
{
"Id": 100654,
"IsikId": 27654,
"ToosuheId": 45987,
"PuhkusLiikKl": {
"Kood": "TsPuhkusLiik|Ajateenistus|1",
"Nimetus": "Ajateenistus"
},
"KehtibAlates": "2021-07-01T00:00:00",
"KehtibKuni": "2022-05-31T00:00:00",
"OnKinnitatud": true
}
]
Aruanded¶
Kasutaja saab käivitada neid aruandeid, mille nägemisõigus talle antud on. Aruande tulemuses kuvatakse kasutajale ainult need töötajad, kes töötavad kasutajale nähtavates struktuuriüksustes.
Läbi API on võimalik pärida 2-te tüüpi aruandeid:
- Tavaaruanded
- Eksportaruanded
Ülevaade kõigist aruannetest
Tagastab ülevaate kõigist võimalikest aruannetest. Igal kliendil on oma enda unikaalne komplekt aruandeid. Siit saab teada ka aruannete Id-d.
Näidisvastus:
[
{
"Id": {aruanne_tool_olevad_isikud_id},
"Nimi": "Tööl olevad isikud",
"Kirjeldus": "Näidatakse valitud perioodil töötavate isikute andmeid.",
"Kaust": "Töö",
"Tyyp": "Kasutaja päring",
"HttpMeetod": "GET",
"Url": "https://persona.fujitsu.ee/Persona/api/reports/get/{aruanne_tool_olevad_isikud_id}"
},
{
"Id": {aruanne_isikuandmed_id},
"Nimi": "Isikuandmed",
"Kirjeldus": "Näidatakse hetkel töötavate isikute isikuandmeid.",
"Kaust": "Isiku andmed",
"Tyyp": "Kasutaja päring",
"HttpMeetod": "GET",
"Url": "https://persona.fujitsu.ee/Persona/api/reports/get/{aruanne_isikuandmed_id}"
}
]Tavaaruanded¶
Tavaaruanded avanevad Persona veebirakenduses HTML tabeli kujul. Näiteid:
- Tööl olevad isikud
- Isikuandmed
- Kontaktandmed
- Puhkused ja töökatkestused
- Tasud ja kinnipidamised
- jne.
Parameetrid:
- yksused : Struktuuriüksuste Id-d, eraldatud komadega. Võimalikud struktuuriüksuste Id-d saab kätte API otspunktist /yksused. Saab kasutada ainult siis, kui veebirakenduses on aruande filtrite hulgas nähav filter "Üksuse valik". Võib jätta tühjaks.
- isikud : Isikute Id-d, eraldatud komadega. Võimalikud isikute Id-d saab kätte API otspunktist /isikud. Saab kasutada siis, kui veebirakenduses on aruande filtrite hulgas nähav filter "Isikute valik". Võib jätta tühjaks.
- alates : Kuupäevade vahemiku algus, ISO 8601 formaadis 'YYYY-MM-DD'. Saab kasutada siis, kui veebirakenduses on aruande filtrite hulgas nähtav filter "Kuupäevade vahemik".
- kuni : Kuupäevade vahemiku lõpp, ISO 8601 formaadis 'YYYY-MM-DD'. Saab kasutada siis, kui veebirakenduses on aruande filtrite hulgas nähav filter "Kuupäevade vahemik".
- kuu : Kuu ja aasta valik, ISO 8601 formaadis 'YYYY-MM-DD'. Väärtustage parameeter soovitud kuu esimese kuupäevaga. Väärtus '2020-01-01' tähistab 2020. aasta jaanuarikuud. Saab kasutada siis, kui veebirakenduses on aruande filtrite hulgas nähav filter "Kuu".
Parameetrite kasutamine:
.../api/reports/get/{Id}?yksused=4686,4688,4701
.../api/reports/get/{Id}?isikud=23788,21008
.../api/reports/get/{Id}?alates=2020-01-01&kuni=2020-01-31
.../api/reports/get/{Id}?kuu=2020-01-01
.../api/reports/get/{Id}?yksused=4686,4688,4701&alates=2020-01-01&kuni=2020-01-31
.../api/reports/get/{Id}?yksused=4686,4688,4701&kuu=2020-01-01
.../api/reports/get/{Id}?isikud=23788,21008&alates=2020-01-01&kuni=2020-01-31
Näidisvastus:
{
"ReportName": "Tööl olevad isikud",
"Results": [
{
"Eesnimi": "Ave",
"Keskmine nimi": "",
"Perekonnanimi": "Aabik",
"Isikukood": "48409125226",
"Muude riikide koodid": "",
"Töötaja number": "123456789",
"Töölepingu number": "TL-56/2018",
"Sugu": "Naine",
"Vanus": 36,
"Sünnikuupäev": "1984-09-12T00:00:00",
"Kodakondsus": "Eesti",
"Sünnikoht": "",
"Haridustase": "Kõrgharidus",
"Kontonumber": "EE462200221001648115",
"Konto omanik": "Ave Aabik",
"Asutusse tuleku kuupäev": "2005-05-05T00:00:00",
"AK nimetus": null,
"AK kood": null,
"Tör Id": null,
"Ametikoht": "Personalidirektor",
"Asukoht struktuuris": "Personaliosakond",
"Ametikoha alguskuupäev": "2018-06-11T00:00:00",
"Ametikoha lõppkuupäev": null,
"Koormus": 1.0000,
"Töötundide arv nädalas": 40.00,
"Töösuhte tüüp": "Põhiametikoht",
"Töötaja grupp": "Juhid",
"Katseaja lõpp": null,
"Teenistustähtaeg": null,
"Profiil": "Töötaja 28",
"Lühendatud tööaeg (3h)": "",
"Töötelefon": null,
"Lühinumber": null,
"Mobiil": "55673321",
"Isiklik telefon": null,
"Töö e-post": null,
"Isiklik e-post": "ave.aabik@hotmail.com",
"Töö aadress": null,
"Asukoht": "Tallinn, Akadeemia tee 21/6",
"Isiklik aadress": "Pärna 16 - 9, Keila linn, Harju maakond, 16546",
"Töökoha aadress": "",
"Aadress (vabatekst)": null,
"IsikId": 19644,
"ToosuheId": 73956,
"YksusId": 4375,
"On koosseisuväline?": "Ei",
"On kohusetäitja?": "Ei",
"Staatus": "Põhipuhkus 28: 21.12.2020 - 28.12.2020",
"Tööstaaž": "15a. 7k. 18p. ",
"Juht": null,
"Summeeritud arvestus": "",
"Lisaväli Kulukoht 1": "082",
"Lisaväli Rendifirmad": "Firma 1",
"Lisaväli Tulemusjuht": "",
"Lisaväli töö sisu": "",
"Lisaväli Ressursikood": null,
"Lisaväli Kulukoht 3": "",
"Lisaväli(Isik) Auto number (lisaväli)": "123PER",
"Lisaväli(Isik) Kabinet": "A77",
"Lisaväli(Isik) Security check": "Done",
"Lisaväli(Isik) Tutvunud sisekorra eeskirjadega": "22.09.2012"
}
]
}Eksportaruanded¶
Eksportaruanded väljastatakse Persona veebirakenduses eeldefineeritud PDF-i või Exceli põhjale. Näiteid:
- Pearaamatukanded
- Palk ja tööjõud
- Töögraafiku väljatrükk
- jne.
Tagasi /
Avaleht