Hakemuspalvelun hakemusten siirtorajapinnan ohje: https://github.com/Opetushallitus/ataru/wiki/Siirto-API 


Swagger kuvaus https://virkailija.testiopintopolku.fi/lomake-editori/api-docs/index.html#!/external45api/post_lomake_editori_api_external_siirto

Rajapinta palauttaa hakijan tiedot sekä hakemuksen vastaukset keyValues kentässä, jonka arvo on tietue jossa avaimet viittaavat kysymyksien tunnisteisiin ja sisältävät mahdollisen tiedon monivalintakysymyksen vastausvaihtoehdosta. Arvot ovat hakijan syöttämiä vastauksia merkkijonoina. Lisäksi palautetaan hakemuksen liitteet attachments kentässä, johon on poimittu keyValues kentästä liitteiden tiedot.

Rajapinnan kutsuminen vaatii session muodostamista seuraavalla protokollalla:

  1. Jos ei olemassa, hae ticket granting ticket (TGT) CAS palvelimelta
  2. Hae service ticket (ST) CAS palvelimelta palvelu URL:lla https://virkailija.testiopintopolku.fi/lomake-editori/auth/cas (QA ympäristössä)
  3. Muodosta sessio tekemällä GET pyyntö https://virkailija.testiopintopolku.fi/lomake-editori/auth/cas?ticket=<ST>. Ota talteen keksi ring-session
  4. Välitä ring-session keksi API kutsuissa

https://wiki.eduuni.fi/display/ophpolku/Rajapintojen+autentikaatio

Suppea CAS REST API ohje https://apereo.github.io/cas/4.2.x/protocol/REST-Protocol.html


Kutsuparametrit

Parametri

Kuvaus

hakukohdeOid (string)Hakukohteen OID. Rajaa tuloksen tietyn hakukohteen tietohin.

Kutsun body

Kuvaus

Malli

Hakemus OID (string array, pakollinen tieto)["1.2.246.562.11.00000000000001687358"]


Vastausviestin tietojen kuvaukset


TietoJSON-elementtiPakollinenPeruste pakollisuudelle, ym. perusteetLuokitus /standardi /suositus /koodisto /arvoalueKommentteja / Avoimia asioita
Hakemuksen OIDhakemusOid









Hakijan tiedotperson


person-elementti
Valtakunnallinen oppijanumeroperson.oidHenkilo



Hakijan etunimetperson.etunimet



Hakijan syntymäaikaperson.syntymaaika



Hakijan hetuperson.hetu



Hakijan sukunimiperson.sukunimi



Hakijan sukupuoliperson.sukupuoli

1 = mies / 2 = nainen

https://virkailija.opintopolku.fi/koodisto-app/koodisto/view/sukupuoli/1


Turvakieltoperson.turvakielto

true / false
Hakijan äidinkieliperson.aidinkieli



Hakijan äidinkielen kielikoodiperson.aidinkieli.kieliKoodi

https://virkailija.opintopolku.fi/koodisto-app/koodisto/view/kieli/1
Hakijan äidinkielen kielityyppiperson.aidinkieli.kieliTyyppi



Hakijan kutsumanimiperson.kutsumanimi



Hakijan kansalaisuudetperson.kansalaisuudet

https://virkailija.opintopolku.fi/koodisto-app/koodisto/view/maatjavaltiot2/2
Hakijan asiointikieliperson.asiointiKieli



Hakijan asiointikielen kielikoodiperson.asiointiKieli.kieliKoodi


person.asiointikieli -elementti
Hakijan asiointikielen kielityyppiperson.asiointiKieli.kieliTyyppi









Haun OIDhakuOid



Hakutoiveiden OID:thakutoiveet


String array






Liitteetattachments


Liitteiden kysymykset ja vastaukset avain-arvo-pareina, poimittu keyValues -muuttujasta






VastauksetkeyValues


Sisältää kaikki lomakkeen kysymykset ja vastaukset avain-arvo-pareina






Hakemuksen hakutoiveiden käsittelymerkinnäthakukohdeReviews

ArrayVain testissä
Hakutoiveen käsittelymerkinnän tunnisterequirement


Vain testissä
Hakutoiveen käsittelymerkinnän tilastate


Vain testissä
Hakutoiveen OIDhakukohde


Vain testissä





 
Hakemuksen hakutoiveiden liitteiden käsittelymerkinnäthakukohdeAttachmentReviews

ArrayVain testissä
Liitteen tunnisteattachment

UUIDVain testissä
Liitteen käsittelyn tilastate


Vain testissä
Hakutoiveen OIDhakukohde


Vain testissä





 


Vastauksen JSON-esimerkki

[
  {
    "hakemusOid": "1.2.246.562.11.00000000000001687358",
    "person": {
      "oidHenkilo": "1.2.246.562.24.89728984982",
      "etunimet": "Aimo Testi",
      "syntymaaika": "1930-09-05",
      "hetu": "050930-9573",
      "sukunimi": "Ahlqvist-Testi",
	  "turvakielto": false,
      "sukupuoli": "1",
      "aidinkieli": {
        "kieliKoodi": "sv",
        "kieliTyyppi": "ruotsi"
      },
	  "kutsumanimi": "Aimo",
	  "kansalaisuudet": [
	    "246",
        "076"
	  ],	
      "asiointiKieli": {
        "kieliKoodi": "fi",
        "kieliTyyppi": "suomi"
      }
    },
    "hakuOid": "1.2.246.562.29.00000000000000017098",
    "hakutoiveet": [
      "1.2.246.562.20.00000000000000025256",
      "1.2.246.562.20.00000000000000026781"
    ],
    "attachments": {
      "64796ca4-0912-400c-a202-7573d1f6fc3c_0": "f996b389-2f36-4ba2-8139-6a7acefe0e3e",
      "64796ca4-0912-400c-a202-7573d1f6fc3c_1": "f996b389-2f36-4ba2-8139-6a7acefe0e3e"
    },
    "keyValues": {
      "secondary-completed-base-education": "0",
      "96e66e82-c84e-404d-a7e6-96bc3ba3173c": "0",
      "db1ec172-3c03-442a-87cd-3866597bdbf7_group0_0": "Terveystieteet, liikuntalääketiede",
      "birth-date": "05.09.1930",
      "higher-completed-base-education_pohjakoulutus_avoin": "pohjakoulutus_avoin",
      "first-name": "Aimo Testi",
      "pohjakoulutus_yo--yes-year-of-completion": "2016",
      "251113da-7f8f-4340-8e96-e6abfc58eab8_group1_0": "Jyväskylän yliopisto",
      "pohjakoulutus_avoin--year-of-completion_group0_0": "2023",
      "0d2004ad-39e6-48ca-9376-687075d1150a": "2016",
      "ssn": "050930-9573",
      "preferred-name": "Aimo",
      "home-town": "091",
      "higher-completed-base-education_pohjakoulutus_yo": "pohjakoulutus_yo",
      "f6a12a31-17bd-4589-945e-d9064f0bc58a_group0": "1",
      "postal-code": "00100",
      "a35bb37d-431d-4b19-a15c-5a30338fd348_group2_0": "2 op.",
      "c79d7ad1-da97-490a-8da9-9ce9c8a910e7_group0_0": "Tampereen ammattikorkeakoulu",
      "nationality_group0": "246",
      "gender": "1",
      "db1ec172-3c03-442a-87cd-3866597bdbf7_group2_0": "Terveystieteet, liikuntalääketiede",
      "email": "hakija-56032810@oph.fi",
      "secondary-completed-base-education–country": "246",
      "pohjakoulutus_avoin--year-of-completion_group1_0": "2023",
      "c9092697-a31a-4494-a738-2a4af99173eb": "0",
      "607c1825-c6d7-4746-9ede-b800320364cc_group0_0": "Urheilijan terveys",
      "asiointikieli": "1",
      "koulutusmarkkinointilupa": "Kyllä",
      "a35bb37d-431d-4b19-a15c-5a30338fd348_group0_0": "4 op.",
      "phone": "050 75642251",
      "607c1825-c6d7-4746-9ede-b800320364cc_group1_0": "Liikunta, terveys ja hyvinvointi elämänkulussa",
      "finnish-vocational-before-1995": "1",
      "higher-completed-base-education_pohjakoulutus_kk": "pohjakoulutus_kk",
      "dc9cbb2e-046a-460e-800e-3d1fdec5f396_group0": "531",
      "postal-office": "HELSINKI",
      "language": "FI",
      "251113da-7f8f-4340-8e96-e6abfc58eab8_group2_0": "Jyväskylän yliopisto",
      "36a6da4f-9e66-4b0e-9fbf-24b9b4b6b71a_0": "f996b389-2f36-4ba2-8139-6a7acefe0e3e",
      "pohjakoulutus_avoin--year-of-completion_group2_0": "2023",
      "country-of-residence": "246",
      "pohjakoulutus_kk--completion-date_group0_0": "2019",
      "607c1825-c6d7-4746-9ede-b800320364cc_group2_0": "Tiedonhankintamenetelmät ja tieteellisen kirjoittamisen perusteet",
      "251113da-7f8f-4340-8e96-e6abfc58eab8_group0_0": "Jyväskylän yliopisto"
    },
    "hakukohdeReviews": [
      {
        "requirement": "payment-obligation",
        "state": "not-obligated",
        "hakukohde": "1.2.246.562.20.00000000000000038323"
      },
      {
        "requirement": "processing-state",
        "state": "processed",
        "hakukohde": "1.2.246.562.20.00000000000000038323"
      },
      {
        "requirement": "eligibility-state",
        "state": "eligible",
        "hakukohde": "1.2.246.562.20.00000000000000038323"
      }
    ],
    "hakukohdeAttachmentReviews": [
      {
        "attachment": "43e42abc-d67f-4c8f-9bdd-990553e5534d",
        "state": "checked",
        "hakukohde": "1.2.246.562.20.00000000000000038323"
      },
      {
        "attachment": "8987d7b6-0335-411c-8080-d871f7b1cc7c",
        "state": "attachment-missing",
        "hakukohde": "1.2.246.562.20.00000000000000038323"
      },
      {
        "attachment": "9859e279-1122-4b59-b5bc-3b5bee8f5a2e",
        "state": "checked",
        "hakukohde": "1.2.246.562.20.00000000000000038323"
      }
    ]
  }
]



  • No labels