Page History: Persona API kasutusjuhend
Compare Page Revisions
Page Revision: 22/12/2020 15:09
Alustamine
API kasutamiseks on vajalik Persona kasutajakonto.
Struktuuriüksuste õiguseid saab Personas seadistada
Avaleht -> Seaded -> Kasutajad
Aruannete õiguseid saab Personas seadistada
Avaleht -> Seaded -> RollidPäringu sooritamine
API testimiseks sobib hästi
PostmanAuthorization
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 (saadaval alates 28.12.2020)
Tulemusse tulevad kõik isikud, kellel on etteantud kuupäevade vahemikus vähemalt üks aktiivne ametikoht ja kelle ametikoht asub kasutajale nähtavas struktuuriüksuses.
Parameetrid:
- yksused : Struktuuriüksuste Id-d, eraldatud komadega. Võimalikud struktuuriüksuste Id-d saab kätte API otspunktist /yksused. Kasutaja näeb ainult neid isikuid, kes asuvad kasutajale nähtavates struktuuriüksustes. Võib jätta tühjaks.
- alates : Ametikoha alguskuupäev. Vaikimisi väärtus 0001-01-01. Võib jätta tühjaks.
- kuni : Ametikoha lõppkuupäev. 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 (saadaval alates 28.12.2020)
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
}
]Aruanded¶
Kasutaja saab käivitada ainult neid aruandeid, mille nägemisõigus kasutajale antud on. Aruande tulemuses kuvatakse kasutajale ainult need töötajad, kes töötavad kasutajale nähtavates struktuuriüksustes.
Läbi Persona API on võimalik pärida 2-te tüüpi aruandeid:
- Tavaaruanded
- Eksportaruanded
Ülevaade kõigist aruannetest (/reports/overview)
Tagastab ülevaate kõigist aruannest, mille avamisõigus on kasutajale antud. Siit saab teada ka aruannete Id-d.
Igal kliendil on oma enda unikaalne komplekt aruandeid.
Tavaaruanded (.../reports/get/{Id})¶
Tavaaruanded avanevad Persona veebirakenduses HTML tabeli kujul. Näiteid:
- Isikuandmed
- Tööl olevad isikud
- Kontaktandmed
- Puhkused ja töökatkestused
- Tasud ja kinnipidamised
- jne.
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": "123",
"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,
"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 (.../reports/export/{Id})¶
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