Persona API kasutusjuhend

Modified on 15/12/2022 13:37 by Administrator — Categorized as: Persona API

Persona API võimaldab RESTful veebiteenuste abil Personast andmeid pärida.
Vaikimisi väljastab API andmeid JSON kujul.

Uuenduste nimekiri

Värskeimat vaadet ja detailsemat juhendit näete siit API Postman

Olemas :

Lisandunud on (info on uues dokumentatsioonis olemas):


Muudatused:

04.02.2022

Uus:

29.11.2021

Muudatused (mõned on breaking changes):
Uus:

22.08.2021


15.08.2021


Alustamine

API testimiseks sobib näiteks Postman

Tingimused

API kasutamiseks on vajalik Persona kasutajakonto.

Struktuuriüksuste ja projektide õiguseid saab Personas seadistada Avaleht -> Seaded -> Kasutajad
Image

API otspunktide ja aruannete õiguseid saab Personas seadistada Avaleht -> Seaded -> Rollid
Image
Image

Authorization

Persona API kasutab Basic Authentication-it

TYPE: Basic Auth
Username: Persona_kasutajanimi
Password: Persona_salasõna
Image

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.

Image

Struktuuriüksused

GET https://persona.fujitsu.ee/persona/api/yksused

Tulemusse tulevad kõik struktuuriüksused, mis on aktiivsed etteantud kuupäevade vahemikus.

Parameetrid:

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,
        "MuutAeg": "2021-06-03T11:19:55"
    },
    {
        "Id": 4688,
        "YlemYksusId": 4686,
        "Nimi": "Kantselei",
        "KehtibAlates": "1993-01-01T00:00:00",
        "KehtibKuni": null,
        "Registrikood": "",
        "Aadress": "",
        "JuhtIsikId": null,
        "MuutAeg": "2021-06-10T15:36:51"
    },
    {
        "Id": 4701,
        "YlemYksusId": 4686,
        "Nimi": "Rahandusosakond",
        "KehtibAlates": "1993-03-01T00:00:00",
        "KehtibKuni": null,
        "Registrikood": "",
        "Aadress": "",
        "JuhtIsikId": null,
        "MuutAeg": "1933-10-10T15:36:51"
    }
]

Isikud

GET https://persona.fujitsu.ee/persona/api/isikud

Tulemusse tulevad kõik isikud, kellel on etteantud kuupäevade vahemikus vähemalt üks aktiivne ametikoht. Kasutaja näeb ainult neid isikud, kes asuvad talle nähtavates struktuuriüksustes.

Parameetrid:

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": {
            "UnikaalneKood": "YlRiik|EST|1",
            "Nimetus": "Eesti"
        },
        "SynniKp": "1957-01-13T00:00:00",
        "SuguKl": {
            "UnikaalneKood": "IsSugu|Mees|1",
            "Nimetus": "Mees"
        },
        "TootajaNr": "1001",
        "MuutAeg": "2021-03-01T13:46:18",
        "OnResident": false
    },
    {
        "IsikId": 21008,
        "Eesnimi": "Tiina",
        "Perekonnanimi": "Sarapuu",
        "Isikukood": "48306125616",
        "ValismaaIsikukood": "",
        "KodakondsusKl": {
            "UnikaalneKood": "YlRiik|EST|1",
            "Nimetus": "Eesti"
        },
        "SynniKp": "1983-06-12T00:00:00",
        "SuguKl": {
            "UnikaalneKood": "IsSugu|Naine|1",
            "Nimetus": "Naine"
        },
        "TootajaNr": "1002",
        "MuutAeg": "2021-03-11T13:46:18",
        "OnResident": true
    }
]

Profiilipilt

GET https://persona.fujitsu.ee/persona/api/failid/profiilipilt/{isikId}

Tulemusse tuleb isiku profiilipilt kujul byte array.

Näidisvastus:

Image











Töösuhted

GET https://persona.fujitsu.ee/persona/api/toosuhted

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:

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": {
            "UnikaalneKood": "TsToosuhteTyyp|Pohitookoht|1",
            "Nimetus": "Põhiametikoht"
        },
        "LepingNr": "TL-5/2020",
        "KehtibAlates": "2020-01-04T00:00:00",
        "KehtibKuni": null,
        "Koormus": 0.7,
        "NadalaTunnid": 28.0000,
        "TootajaGruppKl": null,
        "OnToograafik": true,
        "ToograafikAlates": "2020-01-04T00:00:00",
        "OnLyhendatudTooaeg": true,
        "SumArvestusPerioodKestus": 3,
        "SumArvestusPerioodAlgusKuu": 1,
        "MuutAeg": "2021-01-08T15:09:53"
    },
    {
        "Id": 4005,
        "IsikId": 1803,
        "Ametikoht": {
            "Id": 1201,
            "Nimetus": "Kasutajatoe spetsialist"
        },
        "Yksus": {
            "Id": 5679,
            "Nimetus": "Kasutajatugi"
        },
        "AsukohtStruktuuris": [
            "Tore Firma OÜ",
            "IT osakond",
            "Kasutajatugi"
        ],
        "ToosuhteTyypKl": {
            "UnikaalneKood": "TsToosuhteTyyp|Pohitookoht|1",
            "Nimetus": "Põhiametikoht"
        },
        "LepingNr": "TL-23/2021",
        "KehtibAlates": "2021-02-08T00:00:00",
        "KehtibKuni": null,
        "Koormus": 1.0,
        "NadalaTunnid": 40.0000,
        "TootajaGruppKl": {
            "UnikaalneKood": "TsTootajateGrupp|Tippspetsialistid|1",
            "Nimetus": "Tippspetsialistid"
        },
        "OnToograafik": false,
        "ToograafikAlates": null,
        "OnLyhendatudTooaeg": true,
        "SumArvestusPerioodKestus": null,
        "SumArvestusPerioodAlgusKuu": null
        "MuutAeg": "2022-01-01T15:09:53"
    }
]

Puhkused ja töökatkestused

GET https://persona.fujitsu.ee/persona/api/puhkused

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.
Sisaldab tundlikke isikuandmeid. Veebiteenuselt saadavat infot ei tohiks agregeerimata kujul teistes süsteemides avaldada (nt. siseveeb, kasutajate staatused, infotahvlid, ekraanid).

Parameetrid:

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": {
            "UnikaalneKood": "TsPuhkusLiik|Pohipuhkus|1",
            "Nimetus": "Põhipuhkus 28"
        },
        "KehtibAlates": "2021-07-05T00:00:00",
        "KehtibKuni": "2021-07-25T00:00:00",
        "OnKinnitatud": true,
        "MuutAeg": "2021-06-13T00:00:00"
    },
    {
        "Id": 97274,
        "IsikId": 16284,
        "ToosuheId": 24123,
        "PuhkusLiikKl": {
            "UnikaalneKood": "TsPuhkusLiik|Haigusleht|1",
            "Nimetus": "Haigusleht"
        },
        "KehtibAlates": "2021-07-28T00:00:00",
        "KehtibKuni": "2021-07-30T00:00:00",
        "OnKinnitatud": true,
        "MuutAeg": "2021-07-27T00:00:00"
    },
    {
        "Id": 100654,
        "IsikId": 27654,
        "ToosuheId": 45987,
        "PuhkusLiikKl": {
            "UnikaalneKood": "TsPuhkusLiik|Ajateenistus|1",
            "Nimetus": "Ajateenistus"
        },
        "KehtibAlates": "2021-07-01T00:00:00",
        "KehtibKuni": "2022-05-31T00:00:00",
        "OnKinnitatud": true,
        "MuutAeg": "2021-05-30T00:00:00"
    }
]

Klassifikaatorid

GET https://persona.fujitsu.ee/persona/api/klassifikaatorid

Parameetreid ei ole.

Näidisvastus:
[
    {
        "Kood": "IsSugu",
        "Nimetus": "Sugu",
        "Selgitus": "Isiku sugu",
        "OnKonstant": true,
        "MuutAeg": "2014-01-06T16:24:22"
    },
    {
        "Kood": "TsPuhkusLiik",
        "Nimetus": "Puhkuste ja töökatkestuste liigid",
        "Selgitus": "Puhkuste ja töökatkestuste liigid",
        "OnKonstant": false,
        "MuutAeg": "2014-01-06T16:24:22"
    },
    {
        "Kood": "TsToosuhteTyyp",
        "Nimetus": "Töösuhete liigid",
        "Selgitus": "Töösuhete tüübid",
        "OnKonstant": false,
        "MuutAeg": "2014-01-06T16:24:22"
    },
    {
        "Kood": "YlRiik",
        "Nimetus": "Riigid",
        "Selgitus": "Riikide nimekiri 3-täheliste koodidega",
        "OnKonstant": false,
        "MuutAeg": "2014-01-06T16:24:22"
    }
]

Klassifikaatorite väärtused

GET https://persona.fujitsu.ee/persona/api/klvaartused

Parameetrid:

Näidisvastus:
[
    {
        "UnikaalneKood": "TsPuhkusLiik|Pohipuhkus|1",
        "KlassifikaatorKood": "TsPuhkusLiik",
        "Kood": "Pohipuhkus",
        "LisaId": 1,
        "Nimetus": "Põhipuhkus 28",
        "Selgitus": "Põhipuhkus 28 päeva kalendriaastas",
        "JrkNr": 0,
        "OnKonstant": true,
        "OnKehtiv": true,
        "MuutAeg": "2018-09-07T17:07:20"
    },
    {
        "UnikaalneKood": "TsPuhkusLiik|Haigusleht|1",
        "KlassifikaatorKood": "TsPuhkusLiik",
        "Kood": "Haigusleht",
        "LisaId": 1,
        "Nimetus": "Haigusleht",
        "Selgitus": "",
        "JrkNr": 1,
        "OnKonstant": true,
        "OnKehtiv": true,
        "MuutAeg": "2018-09-07T17:07:20"
    }
]

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:
  1. Tavaaruanded
  2. Eksportaruanded

Ülevaade kõigist aruannetest

GET https://persona.fujitsu.ee/persona/api/reports/overview

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

GET https://persona.fujitsu.ee/persona/api/reports/get/{Id}

Tavaaruanded avanevad Persona veebirakenduses HTML tabeli kujul. Näiteid:
Parameetrid:

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"
        }
    ]
}

Seotud teemad


Tagasi / Avaleht