Tällä sivulla on ohjeita järjestelmätoimittajille varhaiskasvatustietojen siirtoon.

Muutostietojen toimittaminen Vardaan

Varhaiskasvatustietojen muutostiedot

Vardaan toimitetaan lapsen varhaiskasvatusoikeudelle tapahtuvat muutokset luomalla uusi varhaiskasvatuspäätös ja varhaiskasvatussuhde Vardaan. Eli siinäkin tilanteessa, kun uutta varhaiskasvatuspäätöstä ei tehdä lähdejärjestelmään, toimitetaan muuttuneet tiedot Vardaan uutena varhaiskasvatuspäätöksenä ja -suhteena.

  • Kun lapsen voimassa olevalla varhaiskasvatuspäätöksen ja sitä koskevissa tiedoissa tapahtuu muutos, lisätään Vardaan varhaiskasvatupäätökselle ja -suhteelle päättymispäivämäärä.
  • Tämän jälkeen Vardaan luodaan lapselle uusi varhaiskasvatuspäätös ja -suhde muuttuneilla tiedoilla sekä alkamispäivämäärällä, jolloin muutos on astunut voimaan.

Uuden varhaiskasvatuspäätöksen luominen Vardaan on edellytys sille, että Vardassa saadaan tallennettua varhaiskasvatustoimijoilta luotettavaa, yhteismitallista ja vertailukelpoista tietoa myös varhaiskasvatuspäätökseen liittyviin tietoihin tapahtuvista muutoksista ja niiden ajankohdista. Näin toimimalla taataan myös niiden hyödyntäminen siten, että kaikkien varhaiskasvatustoimijoiden eri tavoin tallentamat tiedot ovat yhteismitallisia, vertailukelpoisia ja luotettavia. Sama muuttuneiden tietojen tallentamistapa on käytössä henkilöstöjärjestelmien kohdalla työntekijän ja palvelussuhteen päivittämisessä. Tämä tarkoittaa, että Vardan henkilöitä koskevien tietojen muokkaus toimii läpi koko Vardan samalla logiikalla.


Esimerkki: Lapsi, jolla toistaiseksi voimassa oleva varhaiskasvatuspäätös (alkamispvm. 1.1.2015) viikkotuntimäärällä 38,25h muuttuu 1.10.2020 alkaen viikkotuntimäärään 30h.

  • Vardaan toimitetaan tiedot:
    • Luodaan 1. varhaiskasvatuspäätös: alkamispvm 1.1.2015. viikkotuntimäärällä 38,25h sekä varhaiskasvatussuhde
    • Lapsen tuntimärää vähennetään. Lisätään 1. varhaiskasvatuspäätökselle ja varhaiskasvatuspäätökseen liittyville varhaiskasvatussuhteille päättymispvm 30.9.2020.
    • Luodaan 2. varhaiskasvatuspäätös alkamispvm. 1.10.2020. viikkotuntimäärällä 30h sekä varhaiskasvatussuhde

Tämä toteutus ei kuitenkaan poissulje sitä, että jos ainoastaan varhaiskasvatuspäätöksen kestoon tulee muutos, voidaan alkamis- ja päättymispäivämääriä päivittää olemassa olevalle varhaiskasvatuspäätökselle ja -suhteelle.


Esimerkki: Lapsi, jolla on toistaiseksi voimassa oleva varhaiskasvatuspäätös siirtyy toimipaikasta A toimipaikkaan B, varhaiskasvatuspäätöksellä oleviin tietoihin ei tule muutoksia.

  • Vardaan toimitetaan tiedot:
    • Luodaan 1. varhaiskasvatuspäätös: alkamispvm 1.1.2019 viikkotuntimäärällä 38,25h 
      • Luodaan 1a. varhaiskasvatussuhde toimipaikkaan A: alkamispvm 1.1.2019
      • Lisätään varhaiskasvatussuhteelle toimipaikkaan A: päättymispvm 31.12.2020
      • Luodaan 1b. varhaiskasvatussuhde toimipaikkaan B: alkamispvm 1.1.2021

Varhaiskasvatupäätöksen ja -suhteen tietoja voidaan päivittää vain päivämäärien osalta.

Huoltaja- ja maksutietojen muutostiedot

Vardaan toimitetaan maksutietoihin tapahtuvat muutokset samalla logiikalla, kuin varhaiskasvatustietojen muutokset, eli päättämällä maksutiedot ja luomalla uusi maksutieto muuttuneilla tiedoilla. Eli siinäkin tilanteessa, kun uutta maksupäätöstä ei tehdä varhaiskasvatusjärjestelmään, toimitetaan muuttuneet tiedot Vardaan uutena maksutietona.

Maksutiedoista vain päättymispäivämäärää voidaan päivittää.

Esimerkit varhaiskasvatustietojen siirtoon

Varhaiskasvatuksen järjestäjä

  • Endpoint: /api/v1/vakajarjestajat/{ID}/
    • Sallitut metodit: PUT, PATCH

Varhaiskasvatuksen järjestäjän tietoja voi päivittää, jos palvelukäyttäjällä on tarvittavat oikeudet. Muokattavat kentät on lueteltu Vardan tietoluettelossa.


Esimerkki (PATCH):

{
  "puhelinnumero": "0501231234"
}

Toimipaikka

  • Endpoint: /api/v1/toimipaikat/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/toimipaikat/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH

Toimipaikkaa lisätessä varhaiskasvatuksen järjestäjään voi viitata vakajarjestaja- tai vakajarjestaja_oid-kentällä. Toinen kentistä on pakollinen.

Toimipaikan nimessä sallitut erikoismerkit ovat seuraavat:  ['/', '&', ''', '\'', '`', '´', '+', '-', ',', '('] ja toimipaikan nimi saa päättyä pisteeseen tai ). Esimerkiksi kaksoispiste tai alaviiva eivät ole sallittuja merkkejä toimipaikan nimessä.


Esimerkki (POST):

{
  "vakajarjestaja": "/api/v1/vakajarjestajat/1/",
  "vakajarjestaja_oid": "1.2.246.562.10.34683023489",
  "nimi": "Toimipaikka",
  "kayntiosoite": "Osoite",
  "kayntiosoite_postitoimipaikka": "Postitoimipaikka",
  "kayntiosoite_postinumero": "00109",
  "postiosoite": "Osoite",
  "postitoimipaikka": "Postitoimipaikka",
  "postinumero": "00109",
  "kunta_koodi": "091",
  "puhelinnumero": "+35810123456",
  "sahkopostiosoite": "testi@domain.com",
  "kasvatusopillinen_jarjestelma_koodi": "kj03",
  "toimintamuoto_koodi": "tm01",
  "asiointikieli_koodi": ["FI", "SV"],
  "jarjestamismuoto_koodi": ["jm01"],
  "varhaiskasvatuspaikat": 200,
  "toiminnallinenpainotus_kytkin": false,
  "kielipainotus_kytkin": false,
  "alkamis_pvm": "2020-09-02",
  "paattymis_pvm": null,
  "lahdejarjestelma": "1",
  "tunniste": "tunniste"
}

Toiminnallinen painotus

  • Endpoint: /api/v1/toiminnallisetpainotukset/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/toiminnallisetpainotukset/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH, DELETE

Painotusta lisättäessä toimipaikkaan voi viitata toimipaikka-, toimipaikka_oid-, tai toimipaikka_tunniste-kentällä. Yksi kolmesta kentästä on pakollinen. toimipaikka_tunniste-kenttää käytettäessä toiminnallisen painotuksen lähdejärjestelmä täytyy olla sama, kuin toimipaikan lähdejärjestelmä.


Esimerkki (POST):

{
  "toimipaikka": "/api/v1/toimipaikat/1/",
  "toimipaikka_tunniste": "tunniste",
  "toimipaikka_oid": "1.2.246.562.10.9395737548810",
  "toimintapainotus_koodi": "TP01",
  "alkamis_pvm": "2021-01-02",
  "lahdejarjestelma": "1",
  "tunniste": null
}

Kielipainotus

  • Endpoint: /api/v1/kielipainotukset/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/kielipainotukset/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH, DELETE

Painotusta lisättäessä toimipaikkaan voi viitata toimipaikka-, toimipaikka_oid-, tai toimipaikka_tunniste-kentällä. Yksi kolmesta kentästä on pakollinen. toimipaikka_tunniste-kenttää käytettäessä kielipainotuksen lähdejärjestelmä täytyy olla sama, kuin toimipaikan lähdejärjestelmä.


Esimerkki (POST):

{
  "toimipaikka": "/api/v1/toimipaikat/1/",
  "toimipaikka_tunniste": "tunniste",
  "toimipaikka_oid": "1.2.246.562.10.9395737548810",
  "kielipainotus_koodi": "SV",
  "alkamis_pvm": "2021-01-02",
  "lahdejarjestelma": "1",
  "tunniste": null
}

Henkilö

  • Endpoint: /api/v1/henkilot/
    • Sallitut metodit: POST

Uuden henkilön voi lisätä käyttäen joko henkilotunnus- tai henkilo_oid-kenttää. Jos kyseinen henkilö on jo luotu Vardaan, vastauksena palautetaan olemassa oleva henkilö statuskoodilla 200. Normaalisti uuden henkilön luonnissa vastauksen statuskoodi on 201.

HUOM! Rooliton henkilö (henkilö ilman lapsen/työntekijän/huoltajan roolia) poistetaan Vardasta automaattisesti 5 kuukauden päästä henkilön syöttöhetkestä.


Esimerkki (POST):

{
  "henkilotunnus": "010612-335C",
  "etunimet": "Erkki",
  "kutsumanimi": "Erkki",
  "sukunimi": "Esimerkki"
}


Esimerkki (POST):

{
  "henkilo_oid": "1.2.246.562.24.47279942111",
  "etunimet": "Erkki",
  "kutsumanimi": "Erkki",
  "sukunimi": "Esimerkki"
}

Lapsi

  • Endpoint: /api/v1/lapset/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/lapset/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH, DELETE
  • Endpoint: /api/v1/lapset/{ID tai lähdejärjestelmä:tunniste}/delete-all/
    • Sallitut metodit: DELETE

Lasta lisättäessä henkilöön voi viitata henkilo- tai henkilo_oid-kentällä. PAOS-lapsen luonnissa käytetään oma_organisaatio/oma_organisaatio_oid- ja paos_organisaatio/paos_organisaatio_oid-kenttiä. Varhaiskasvatuksen järjestäjien välillä täytyy olla voimassa oleva PAOS-sopimus. Muutoin käytetään vakatoimija- tai vakatoimija_oid-kenttää.


Esimerkki (POST):

{
  "vakatoimija": "/api/v1/vakajarjestajat/1/",
  "vakatoimija_oid": "1.2.246.562.10.34683023489",
  "henkilo": "/api/v1/henkilot/1/",
  "henkilo_oid": "1.2.246.562.24.47279942111",
  "lahdejarjestelma": "1",
  "tunniste": "tunniste"
}


Esimerkki (POST):

{
  "oma_organisaatio": "/api/v1/vakajarjestajat/1/",
  "oma_organisaatio_oid": "1.2.246.562.10.34683023489",
  "paos_organisaatio": "/api/v1/vakajarjestajat/2/",
  "paos_organisaatio_oid": "1.2.246.562.10.34683023488",
  "henkilo": "/api/v1/henkilot/1/",
  "henkilo_oid": "1.2.246.562.24.47279942111",
  "lahdejarjestelma": "1",
  "tunniste": "tunniste"
}


Lapsi-objektin ja kaikki lapseen liittyvät tiedot (varhaiskasvatuspäätökset, varhaiskasvatussuhteet, maksutiedot) voi poistaa yhdellä kutsulla käyttämällä /delete-all/-endpointia.

Esimerkki (DELETE):

  • DELETE /api/v1/lapset/1/delete-all/
  • DELETE /api/v1/lapset/1:lapsi-tunniste/delete-all/

Varhaiskasvatuspäätös

  • Endpoint: /api/v1/varhaiskasvatuspaatokset/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/varhaiskasvatuspaatokset/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH, DELETE

Varhaiskasvatuspäätöstä lisättäessä lapseen voi viitata lapsi- tai lapsi_tunniste-kentällä.


Esimerkki (POST):

{
  "lapsi": "/api/v1/lapset/1/",
  "lapsi_tunniste": "tunniste",
  "tuntimaara_viikossa": "37.5",
  "jarjestamismuoto_koodi": "jm01",
  "hakemus_pvm": "2021-01-02",
  "alkamis_pvm": "2021-01-02",
  "paattymis_pvm": null,
  "tilapainen_vaka_kytkin": false,
  "vuorohoito_kytkin": false,
  "paivittainen_vaka_kytkin": true,
  "kokopaivainen_vaka_kytkin": true,
  "lahdejarjestelma": "1",
  "tunniste": "tunniste"
}

Varhaiskasvatussuhde

  • Endpoint: /api/v1/varhaiskasvatussuhteet/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/varhaiskasvatussuhteet/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH, DELETE

Varhaiskasvatussuhdetta lisättäessä varhaiskasvatuspäätökseen voi viitata varhaiskasvatuspaatos- tai varhaiskasvatuspaatos_tunniste-kentällä. Toimipaikkaan voi viitata toimipaikka-, toimipaikka_oid-, tai toimipaikka_tunniste-kentällä.


Esimerkki (POST):

{
  "varhaiskasvatuspaatos": "/api/v1/varhaiskasvatuspaatokset/1/",
  "varhaiskasvatuspaatos_tunniste": "tunniste",
  "toimipaikka": "/api/v1/toimipaikat/1/",
  "toimipaikka_oid": "1.2.246.562.10.9395737548810",
  "toimipaikka_tunniste": "tunniste",
  "alkamis_pvm": "2021-01-02",
  "paattymis_pvm": null,
  "lahdejarjestelma": "1",
  "tunniste": null
}

Maksutieto

  • Endpoint: /api/v1/maksutiedot/
    • Sallitut metodit: POST
  • Endpoint: /api/v1/maksutiedot/{ID tai lähdejärjestelmä:tunniste}/
    • Sallitut metodit: PUT, PATCH, DELETE

Vardaan päivitetään huoltajat kerran päivässä Oppijanumerorekisteristä. Maksutietoa ei voi lisätä heti lapsen luonnin jälkeen, vaan täytyy odottaa seuraavaan päivään. Maksutietoa lisättäessä huoltajaan voi viitata joko henkilötunnuksella tai henkilön oppijanumerolla. Lapseen voi viitata lapsi- tai lapsi_tunniste-kentällä.

Ks. Testihuoltajia ja -huollettavia maksutietojen testausta varten


Esimerkki (POST):

{
  "lapsi": "/api/v1/lapset/1/",
  "lapsi_tunniste": "tunniste",
  "huoltajat": [
    {
      "henkilotunnus": "120386-109V",
      "etunimet": "Pirkko",
      "sukunimi": "Virtanen"
    },
    {
      "henkilo_oid": "1.2.246.562.24.47279942111",
      "etunimet": "Pertti",
      "sukunimi": "Virtanen"
    }
  ],
  "maksun_peruste_koodi": "mp01",
  "palveluseteli_arvo": 0,
  "asiakasmaksu": 10,
  "perheen_koko": 2,
  "alkamis_pvm": "2021-03-01",
  "paattymis_pvm": "2022-01-01",
  "lahdejarjestelma": "1",
  "tunniste": "tunniste"
}


Maksutietoon liittyviä huoltajia voi lisätä PUT- ja PATCH-kutsuilla käyttämällä huoltajat_add-kenttää.

Esimerkki (PATCH):

{  
  "huoltajat_add": [
    {
      "henkilotunnus": "120386-109V",
      "etunimet": "Pirkko",
      "sukunimi": "Virtanen"
    }
  ]
}