In English | Katso myös Helsingin kaupungin palvelukartan ja toimipisterekisterin REST-rajapinta

Helsingin, Espoon, Vantaan ja Kauniaisten kaupunkien Palvelurekisterin REST-rajapinta

Palvelurekisterin REST-rajapinnan käyttöehdot

Sinulla on oikeus: Seuraavilla ehdoilla:

Rajapinnan käyttö ja palaute rajapinnasta

Rajapinta tarjoaa mahdollisuudet kysellä ja käyttää Helsingin, Espoon, Vantaan ja Kauniaisten kaupunkien Palvelurekisterin tietoja omissa verkkosovelluksissasi helposti. Rajapintaa on kehitetty REST-mallien mukaisesti ja voit kysellä tietoa joko JSON tai XML-muodossa.

Otamme mielellämme vastaan palautetta rajapinnasta sekä siitä kuinka käytätte rajapintaa hyväksi projekteissanne. Voit lähettää palautteesi sähköpostilla osoitteeseen leila.oravisto@hel.fi

Julkaisuhistoria

5/2013 - Ensimmäisen version julkaisu

11/2014 - Description-objektiin lisätty unit_ids, joka sisältää kuvaukseen liittyvien toimipisteiden id-koodit. Koodit vastaavat Helsingin kaupungin palvelukartan ja toimipisterekisterin REST-rajapinnan kooditusta.

6/2017 - Description ja Errandservice-objekteihin lisätty mahdollisuus rajata tuloksia municipality-parametrilla (municipality=91 on oletusarvo [Helsinki], muut 49 [Espoo], 92 [Vantaa], 235 [Kauniainen]).

Tämä on rajapinnan ensimmäinen versio ja sisältää hakutoiminnallisuuksia palvelukuvausten ja asiointipalvelujen kyselemiseksi.

Mitä rajapinnan kautta voi kysellä

Rajapinnan kautta pystytään kyselemään seuraavia tietoja:

Tietojen kyseleminen rajapinnasta

Tietoja voidaan kysyä rajapinnasta joko yksi tietoalkio kerrallaan - tai listauksina, joka palauttaa tiedot kaikista ko. tyypin tietoalkioista yhdellä kertaa.

Osoitteet joista tietoa voi kysellä, muodostuvat seuraavalla tavalla:

Esimerkkikysely kaikkien tietoalkioiden listaamiseksi
http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/

Yllä oleva kysely palauttaa Helsingin kaikki julkiset palvelukuvaukset listana JSON-objekteja (Helsingin palvelukuvaukset ovat oletusarvo; jos ulos halutaan Espoon palvelukuvaukset, käytä parametria municipality=49). Huomioitavaa on, että tietomalleissa listauksen tietomalli on rajoitetumpi yhden objektin kyselyn tietomalliin verrattuna. Tämä on dokumentoituna alempana tietomallien kohdalla.

Esimerkkikysely yhden tietoalkion tietojen saamiseksi
http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484

Yllä oleva kysely palauttaa tiedot palvelukuvauksesta, jonka id = 2484.

Rajapinta palauttaa oletusarvoisesti suomenkielisiä tietoalkioita. Jos haluat hakea muunkielistä dataa, käytä language-parametria, jonka mahdolliset arvot ovat fi, sv, en, fi2, sv2 ja en2 (jälkimmäiset kolme ovat selkokielisiä versioita).
Esimerkiksi: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?municipality=91&language=en

Rajapinta palauttaa tiedot oletuksena JSON-muodossa ja tukee JSONP-tyyppistä kyselyä, mikäli kyselyyn liittää mukaan callback-parametrin.
Esimerkiksi: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484/?callback=foo

Mikäli data halutaan XML-muodossa, on mahdollista liittää kyselyyn parametri ?format=xml
Esimerkiksi: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484/?format=xml

Datamallien kuvaus

Palvelukuvaus

Esimerkkiobjekti yksittäisestä palvelukuvauksesta (http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484):

{"id":2484,"main_description":true,"service_id":10055,"title":"Päivähoito eli varhaiskasvatus","name_synonyms":"Varhaiskasvatus, päivähoito","description_short":"Vanhemmat voivat valita päivähoidon kunnallisessa tai yksityisessä päiväkodissa, perhepäivähoidossa tai leikkitoiminnan kerhossa. Varhaiskasvatusta haetaan neljä kuukautta ennen päivähoidon tarvetta.","description_long":"Vanhemmat voivat valita varhaiskasvatuksen kunnallisessa tai yksityisessä päiväkodissa, perhepäivähoidossa tai leikkitoiminnan kerhossa. Varhaiskasvatukseen haetaan neljä kuukautta ennen sen tarvetta.\n\n Varhaiskasvatusvirasto vastaa suomenkielisestä ja opetusvirasto ruotsinkielisestä varhaiskasvatuksesta ja esiopetuksesta.","servicemap_url":"https://palvelukartta.hel.fi/unit?treenode=868&organization=83e74666-0836-4c1d-948a-4b34a8b90301","provided_languages":["fi","en","sv"], "responsible_depts":["cc70d1d8-3ca7-416a-9ea7-27e6b7ce58a8"],"target_groups":["CHILDREN_AND_FAMILIES"],"life_events":[],"provider_types":[],"errand_services":[506],"exact_errand_services":[506],"links":[{"type":"INTERNET","title":"Leikkitoiminnan kerhot", "url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/leikki-ja-avoin-toiminta/leikkitoiminnan-kerhot/kerhot-leikkipuistoissa-ja-paivakodeissa/","file_format":"HTML"},{"type":"INTERNET","title":"Yksityiset päiväkodit", "url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/paivahoito/yksityinen-paivahoito/yksityinen-paivakotihoito/postinumerot/","file_format":"HTML"},{"type":"INTERNET","title":"Perhepäivähoito","url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/paivahoito/perhepaivahoito/", "file_format":"HTML"},{"type":"INTERNET","title":"Kunnalliset päiväkodit","url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/paivahoito/paivakotihoito/paivakodit/","file_format":"HTML"},{"type":"INTERNET","title":"Hakeminen varhaiskasvatukseen", "url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/paivahoito/paivakotihoito/hakeminen/","file_format":"HTML"}],"availabilities":[], "unit_ids":[1,2,3,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,20,21,22,23,24,25,26,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63, 64,65,66,67,68,69,70,71,72,73,74,75,77,78,79,80,81,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,106,107,108,109,110,111,112,113,114,115,116,117, 118,119,120,121,122,123,124,125,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,144,145,146,147,148,149,150,151,152,153,154,155,156,157,159,160,161,164,166, 167,168,169,170,171,172,173,174,175,176,177,178,180,181,182,183,185,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212, 213,214,216,217,218,219,220,221,222,223,224,225,227,228,229,231,232,233,234,235,236,237,239,241,242,243,244,245,246,247,248,250,251,253,254,255,257,258,259,260,261,262,265, 266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,287,288,289,290,292,293,294,295,296,297,298,299,300,301,303,304,306,307,308,309,310,312,313, 314,315,316,317,319,320,321,322,323,324,325,326,327,329,330,331,332,333,334,335,336,337,339,340,341,343,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361, 362,363,364,365,366,367,368,369,370,371,372,373,375,376,378,379,380,381,382,383,384,385,386,387,388,389,391,392,395,396,415,417,419,423,424,425,429,430,431,432,433,434,435, 440,442,443,444,445,446,448,449,450,498,500,502,503,507,508,509,511,514,515,535,537,538,543,544,1986,2126,2194,2199,2250,2266,2321,2567,2592,2803,2859,2863,2914,3086,3154, 3438,3852,4008,6500,6540,6561,6640,7962,8401,8700,8701,8860,8961,8980,9122,9123,9124,9332,10402,10404,10405,10422,10563,10582,11342,14442,14483,14484,17648,17763,21455, 22416,22725,22780,24196,24622,25393,25444,25762,25763,25773,27475,28383,28384,28398,28399,29663,29842,29844,29849,29851,29854,29855,30033,30716,31009,32246,32330,32398, 32522,32898,32978,33748,33750,34645,34820,43328,43439,43673,43675,43677,43680,43739,43740,43743,43806,43808,43809,43874,43875,43876,43877,43878,43879,44355,44392,44401, 44461,44637,44880,45019,45587,45593,46228,46470,48923,49017,50064,50065,50383,50384,50385,50579,51264,53369,53377,53518,54059,54094,54095,54096,54097,54098,54100,54412, 54413,54414,54415,54416,54451,54452,54453,54454,54455,54456,54457,54458,55403,55404,55407,55408,55409,55412,55413,55417,55418,55419,55420,55421,55422,55423,55426,55427, 55428,55431,55433,55434,55436,55437,55442,55443,55445,55446,55447,55449,55450,55452,55454,55455,55456,55457,55458,55459,55462,55463,55464,55465,55466,55467,55468,55469, 55470,55471,55472,55473,55475,55478,55479,55480,55481,55482,55483,55484,55485,55486,55487,55489,55490,55492,55493,55494,55497,55500,55502,55503,55507,55508,55509,55510, 55511,55512,55513,55515,55516,55517,55518,55519,55520,55521,55522,55523,55526,55527,55528,55529,55530,55531,55534,55536,55540,55541,55542,55543,55544,55545,55548,55551, 55552,55553,55554,55557,55559,55561,55562,55565,55567,55568,55569,55570,55572,55575,55576,55578,55579,55580,55584,55585,55586,55587,55588,55589,55591,55592,55594,55597, 55598,55600,55606,55608,55609,55613,55614,55615,55616,55618,55621,55622,55623,55624,55625,55626,55627,55628,55629,55630,55633,55637,55640,55641,55642,55644,55646,55647, 55648,55649,55651,55652,55654,55655,55658,55659,55661,55663,55667,55668,55669,55670,55671,55672,55673,55675,55677,55678,55679,55680,55681,55684,55685,55686,55687,55689, 55691,55692,55693,55694,55695,55696,55697,55698,55699,55704,55705,55708,55711,55712,55713,55714,55715,55717,55718,55721,55722,55723,55724,55725,55728,55730,55731,55732, 55734,55738,55741,55742,55743,55746,55747,55750,55751,55756,55757,55758,55760,55761,55762,55763,55764,55768,55769,55770,55775,55776,55777,55779,55781,55782,55783,55785, 55786,55790,55793,55794,55795,55796,55797,55798,55799,55800,55803,55805,55807,55808,55810,55813,55814,55815,55817,55819,55821,55822,55823,55824,55825,55826,55828,55831, 55835,55836,55838,55839,55840,55841,55842,55843,55844,55845,55846,55849,55850,55852,55853,55854,55856,55858,55947,56113,56340,56592,56614]}


Esimerkkiobjekti palvelunkuvausten listauksesta (http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/):

{"id":2484,"main_description":true,"service_id":10055,"title":"Päivähoito eli varhaiskasvatus","description_short":"Vanhemmat voivat valita päivähoidon kunnallisessa tai yksityisessä päiväkodissa, perhepäivähoidossa tai leikkitoiminnan kerhossa. Varhaiskasvatusta haetaan neljä kuukautta ennen päivähoidon tarvetta."}
AttribuuttiArvon selitys
idPalvelukuvauksen tunniste
main_descriptionOnko kyseessä pääkuvaus (true) vai alikuvaus (false)
service_idPääkuvauksen ja alikuvausten yhdistävä palvelutunniste
titlePalvelukuvauksen otsikko
name_synonymsPalvelukuvauksen otsikon synonyymit
description_shortLyhyt palvelukuvaus (ingressi)
description_longPalvelukuvaus
availability_summaryPalvelun ajallinen saatavuus kootusti
prerequisitesPalvelun käytön edellytykset
informationLisätietoja palvelusta
servicemap_urlwww-osoite palvelukartalle
provided_languagesPalvelun kielet
responsible_deptsPalvelusta vastaavat yksiköt. Yksiköiden koodit vastaavat Helsingin kaupungin palvelukartan ja toimipisterekisterin REST-rajapinnan v4/department-kyselyn kooditusta.
target_groupsPalvelun kohderyhmät (mahdolliset arvot otsikon "Tyypitykset" alla)
life_eventsPalvelun elämäntilanteet (mahdolliset arvot otsikon "Tyypitykset" alla)
provider_typesPalvelun sopimuslajit (mahdolliset arvot otsikon "Tyypitykset" alla)
errand_servicesLista asiointipalveluiden tunnuksia, jotka liittyvät tämän ja vastaavien palvelujen kokonaisuuteen
exact_errand_servicesLista asiointipalveluiden tunnuksia, joilla asioit juuri tässä palvelussa
linksLista palveluun liittyvistä linkeistä objekteina. Objekti sisältää kentät: type, title, url, file_format.
availabilitiesLista palveluun ajallisista saatavuuksista objekteina. Objekti sisältää kentän availability_string.
unit_idsLista toimipisteiden id-koodeista, joita tämä palvelukuvaus koskee. Id-koodit vastaavat Helsingin kaupungin palvelukartan ja toimipisterekisterin REST-rajapinnan kooditusta.

Asiointipalvelu

Esimerkkiobjekti yksittäisestä asiointipalvelusta (http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/506):

{"id":506,"description_id":2484,"exact_descriptions":[2484,2768,3158],"service_id":10055,"type":"APPLICATION","name":"Hakemus varhaiskasvatukseen tai esiopetukseen","description":"Tällä hakemuksella huoltaja voi hakea lapselleen Helsingin kaupungin varhaiskasvatusta, esiopetusta tai kerhotoimintaa.", "process_description":"Hakemuslomakkeen ohjeteksti ohjaa lomakkeen täyttämisessä. Puuttuvat tiedot tai virheelliset tiedot näkyvät punaisella vasemman reunan navigaatiossa ja Yhteenveto-sivulla. Lähetä-painike aktivoituu vasta, kun kaikki lomakkeen pakolliset kentät on täytetty. Lähettämisen jälkeen lomake ei ole muokattavissa, mutta lähetettyä hakemusta voi käyttää esim. sisaruksen hakemuksen pohjana.\n\nHakemuksen voi tallentaa luonnoksena ja luonnosta voi myöhemmin muokata asiointikansiossa. Luonnos katoaa hakemuksen lähettämisen yhteydessä.\n\n Lähetetty hakemus tallentuu hakijan asiointikansioon, sähköisen asioinnin arkistointijärjestelmään ja kasvatuksen ja koulutuksen toimialan varhaiskasvatuksen ja esiopetuksen asiakastietojärjestelmään. Palvelu antaa ilmoituksen lähetyksen onnistumisesta ja asianumeron, jolla hakija voi seurata hakemuksen tilaa asiointikansiossa. Lähetetyn, käsittelyä odottavan hakemuksen tila on Lähetetty. Kun hakemus otetaan käsittelyyn, hakemuksen tilaksi muuttuu Käsittelyssä.\n\n Päätös hoitopaikasta lähetetään sähköisesti lapsen kanssa samassa osoitteessa asuville huoltajille heidän henkilökohtaisiin asiointikansioihinsa, mikäli heillä on asiointikansio. Päätös lähetetään sähköisenä myös lapsen kanssa toisessa osoitteessa asuvalle huoltajalle, mikäli kyseessä on yhteishuoltajuus ja yhteishuoltajalla on henkilökohtainen asiointikansio.\n\nMaksupäätökset toimitetaan sähköisesti asiointikansioon sille huoltajalle, joka asiakasmaksuyksikölle on ilmoitettu olevan vastuussa maksuista. \n\n Hakemus voidaan poistaa ennen päätöksen tekemistä ottamalla yhteyttä hakemukselle ensimmäiseksi kirjatun toimipisteen johtajaan. Poistetun hakemuksen tila on Peruutettu.\n\nKäsittelyaikana hakemukseen tulevista muutoksista ilmoitetaan soittamalla ensiksi kirjatun toimipisteen johtajalle tai perhepäivähoidon ohjaajalle.","processing_time":"Hakemuksen käsittelyaika on enintään neljä kuukautta, ellei hakija ilmoita hoidon alkamiselle myöhäisempää alkamispäivää. Hakemuksen käsittely alkaa noin kaksi kuukautta ennen toivottua aloituspäivää.", "expiration_time":"Hakemus on voimassa yhden vuoden lähetyspäivästä lukien.","information":"Hakemuksen voi lähettää aikaisintaan vuotta ennen hoidon toivottua alkamispäivää.\n\nHakemuksen voivat toimittaa myös Helsingin ulkopuolella asuvat. Varhaiskasvatuspalvelun saamisen edellytyksenä on, että perheellä on hoidon alkaessa kotipaikkana Helsinki.","provided_languages":["fi","sv"],"responsible_depts":["cc70d1d8-3ca7-416a-9ea7-27e6b7ce58a8"],"target_groups":["INDIVIDUALS"],"life_events":[],"links":[{"type":"INTERNET","title":"Tietoa varhaiskasvatuksesta", "url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/paivahoito/paivahoidon-vaihtoehdot/"},{"type":"INTERNET","title":"Varhaiskasvatusmaksut","url":"https://www.hel.fi/Helsinki/fi/paivahoito-ja-koulutus/paivahoito/paivahoitomaksut/"},{"type":"INTERNET","title":"Kasvatuksen ja koulutuksen toimiala","url":"https://www.hel.fi/kasvatuksen-ja-koulutuksen-toimiala/fi"}],"channels":[{"id":841,"type":"ESERVICE","type_string":"Verkkoasiointi","name":"Päivähoitohakemus verkossa","prerequisites":"Edellyttää tunnistamista joko henkilökohtaisilla verkkopankkitunnuksilla tai mobiilivarmenteella.", "availability_summary":"Palvelu saatavilla joka päivä ympäri vuorokauden.","process_description":"Asian käsittelyn tilaa voi seurata asiointikansiossa. Hakemuksen tilan muuttumisesta ja uudesta palvelu- tai maksupäätöstapahtumasta asiointikansion omistaja saa herätteen sähköpostilla tai tekstiviestinä. Herätteen toimitustavan voi valita asiointikansiossa Omat tiedot -sivulla.","provided_languages":["fi","sv","en"],"requires_authentication":true,"saved_to_customer_folder":true,"e_processing":false,"e_decision":true,"payment_enabled":false,"for_personal_customer":true,"for_corporate_customer":false, "links":[{"type":"FEEDBACK","title":"Palautetta varhaiskasvatuksesta tai esiopetuksesta","url":"https://www.hel.fi/kasvatuksen-ja-koulutuksen-toimiala/fi/yhteystiedot-ja-palaute/Anna+palautetta/anna-palautetta-vaka","file_format":"HTML"},{"type":"INTERNET","title":"Siirry palveluun","url":"https://asiointi.hel.fi/wps/myportal/lomakkeet/paivahoito?COHESServiceCase=DAYCAREAPPLICATION","file_format":"HTML"}],"availabilities":[{"availability_string":"Palvelu saatavilla joka päivä ympäri vuorokauden"}]}]}


Esimerkkiobjekti asiointipalvelusta listauksessa (http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/):

{"id":506,"description_id":2484,"service_id":10055,"type":"APPLICATION","name":"Hakemus varhaiskasvatukseen tai esiopetukseen","description":"Tällä hakemuksella huoltaja voi hakea lapselleen Helsingin kaupungin varhaiskasvatusta, esiopetusta tai kerhotoimintaa.","process_description":"Hakemuslomakkeen ohjeteksti ohjaa lomakkeen täyttämisessä. Puuttuvat tiedot tai virheelliset tiedot näkyvät punaisella vasemman reunan navigaatiossa ja Yhteenveto-sivulla. Lähetä-painike aktivoituu vasta, kun kaikki lomakkeen pakolliset kentät on täytetty. Lähettämisen jälkeen lomake ei ole muokattavissa, mutta lähetettyä hakemusta voi käyttää esim. sisaruksen hakemuksen pohjana.\n\nHakemuksen voi tallentaa luonnoksena ja luonnosta voi myöhemmin muokata asiointikansiossa. Luonnos katoaa hakemuksen lähettämisen yhteydessä.\n\nLähetetty hakemus tallentuu hakijan asiointikansioon, sähköisen asioinnin arkistointijärjestelmään ja kasvatuksen ja koulutuksen toimialan varhaiskasvatuksen ja esiopetuksen asiakastietojärjestelmään. Palvelu antaa ilmoituksen lähetyksen onnistumisesta ja asianumeron, jolla hakija voi seurata hakemuksen tilaa asiointikansiossa. Lähetetyn, käsittelyä odottavan hakemuksen tila on Lähetetty. Kun hakemus otetaan käsittelyyn, hakemuksen tilaksi muuttuu Käsittelyssä.\n\nPäätös hoitopaikasta lähetetään sähköisesti lapsen kanssa samassa osoitteessa asuville huoltajille heidän henkilökohtaisiin asiointikansioihinsa, mikäli heillä on asiointikansio. Päätös lähetetään sähköisenä myös lapsen kanssa toisessa osoitteessa asuvalle huoltajalle, mikäli kyseessä on yhteishuoltajuus ja yhteishuoltajalla on henkilökohtainen asiointikansio.\n\nMaksupäätökset toimitetaan sähköisesti asiointikansioon sille huoltajalle, joka asiakasmaksuyksikölle on ilmoitettu olevan vastuussa maksuista. \n\n Hakemus voidaan poistaa ennen päätöksen tekemistä ottamalla yhteyttä hakemukselle ensimmäiseksi kirjatun toimipisteen johtajaan. Poistetun hakemuksen tila on Peruutettu.\n\nKäsittelyaikana hakemukseen tulevista muutoksista ilmoitetaan soittamalla ensiksi kirjatun toimipisteen johtajalle tai perhepäivähoidon ohjaajalle.","processing_time":"Hakemuksen käsittelyaika on enintään neljä kuukautta, ellei hakija ilmoita hoidon alkamiselle myöhäisempää alkamispäivää. Hakemuksen käsittely alkaa noin kaksi kuukautta ennen toivottua aloituspäivää.","expiration_time":"Hakemus on voimassa yhden vuoden lähetyspäivästä lukien.", "information":"Hakemuksen voi lähettää aikaisintaan vuotta ennen hoidon toivottua alkamispäivää.\n\nHakemuksen voivat toimittaa myös Helsingin ulkopuolella asuvat. Varhaiskasvatuspalvelun saamisen edellytyksenä on, että perheellä on hoidon alkaessa kotipaikkana Helsinki.","provided_languages":[],"responsible_depts":["cc70d1d8-3ca7-416a-9ea7-27e6b7ce58a8"],"target_groups":[],"life_events":[]}
AttribuuttiArvon selitys
idAsiointipalvelun tunniste
description_idPalvelukuvauksen tunniste
exact_descriptionsNiiden palvelukuvausten tunnisteet, joissa asioit tällä asiointipalvelulla
service_idPääkuvauksen ja alikuvausten yhdistävä palvelutunniste
typeAsiointipalvelun tyyppi (mahdolliset arvot otsikon "Tyypitykset" alla)
nameAsiointipalvelun nimi
descriptionAsiointipalvelun lyhyt kuvaus
process_descriptionAsian käsittelyn eteneminen
processing_timeAsian käsittelyaika
expiration_timeVoimassaoloaika
costsAsiointipalveluun liittyvät maksut
informationLisätietoja asiointipalvelusta
responsible_deptsPalvelusta vastaavat yksiköt. Yksiköiden koodit vastaavat Helsingin kaupungin palvelukartan ja toimipisterekisterin REST-rajapinnan v4/department-kyselyn kooditusta.
linksLista palveluun liittyvistä linkeistä objekteina. Objekti sisältää kentät: type, title, url, file_format.
channelsLista asiointipalvelun palvelukanavista objekteina. Kanavan objekti on kuvattu omassa kappaleessaan.

Palvelukanava

Palvelukanavat liittyvät aina johonkin asiointipalveluun, joten palvelukanavia ei voida hakea yksittäin vaan ainoastaan osana asiointipalvelua.

AttribuuttiArvon selitys
idPalvelukanavan tunniste
typePalvelukanavan tyyppi (mahdolliset arvot otsikon "Tyypitykset" alla)
type_stringPalvelukanavan tyyppi tekstimuotoisena
namePalvelukanavan nimi
prerequisitesPalvelukanavan käytön edellytykset
informationPalvelukanavaa koskevia lisätietoja
availability_summaryPalvelukanavan ajallinen saatavuus kootusti
process_descriptionPalvelukanavan prosessin kuvaus
personal_service_street_addressHenkilökohtaisen palvelukanavan posti- tai käyntiosoite
personal_service_postal_codeHenkilökohtaisen palvelukanavan postinumero
personal_service_cityHenkilökohtaisen palvelukanavan postitoimipaikka
phonePalvelukanavan puhelinnumero
faxPalvelukanavan faksinumero
emailPalvelukanavan sähköpostiosoite
form_numberPalvelukanavan lomakkeen numero
provided_languagesPalvelukanavan kielet
requires_authenticationVaatiiko palvelukanava tunnistautumista (true/false)
saved_to_customer_folderTallentuuko tiedot asiointikansioon (true/false)
e_processingOnko sähköinen käsittely (true/false)
e_decisionOnko päätös saatavilla sähköisesti (true/false)
payment_enabledOnko maksaminen mahdollista (true/false)
for_personal_customerOnko palvelukanava henkilöasiakkaille (true/false)
for_corporate_customerOnko palvelukanava yritys- ja yhteisöasiakkaille (true/false)
linksLista palvelukanavaan liittyvistä linkeistä objekteina. Objekti sisältää kentät: type, title, url, file_format.
availabilitiesLista palvelukanavan ajallisista saatavuuksista objekteina. Objekti sisältää kentän availability_string.

Hakusana

Listaus kaupungin palvelukuvauksiin liittyvistä hakusanoista. Hakusanat muodostuvat palvelukuvauksien nimistä ja synonyymeistä (oletusarvo on municipality=91 [Helsinki], muut 49 [Espoo], 92 [Vantaa], 235 [Kauniainen]).

Esimerkkiobjekti yksittäisestä hakusanasta (http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/searchword/?municipality=91):

{"search_word":"Ammatillinen peruskoulutus","weight":2}
AttribuuttiArvon selitys
search_wordHakusana
weightKuinka monta palvelukuvausta hakusanalla löytyy

Tyypitykset

provider_type

Palvelun tuottajien sopimuslajit:

Tyypin kooodiSelitys
101Kunnan tuottama palvelu
102Kunnan tukema palvelu
103Kuntayhtymän tuottama palvelu
104Valtion tuottama palvelu
105Yksityisen palveluntuottajan tuottama palvelu

target_group

Palvelun kohderyhmät:

Tyypin kooodiSelitys
ASSOCIATIONSYhdistykset
CHILDREN_AND_FAMILIESLapset ja lapsiperheet
YOUTHNuoret
ELDERLY_PEOPLEVanhukset
DISABLEDVammaiset
IMMIGRANTSMaahanmuuttajat
ENTERPRISESYritykset

errand_service_type

Asiointipalvelun tyypit:

Tyypin kooodiSelitys
NOTICEIlmoitus
APPOINTMENTAjanvaraus
APPLICATIONHakemus
ADVICENeuvonta
COMMUNICATIONViestitys
ECOMMERCEKauppa
ORDERINGTilaus
INFORMATION_SERVICETietopalvelu
ENROLLMENTIlmoittautuminen
HEARINGKuuleminen

channel_type

Palvelukanavien tyypit:

Tyypin kooodiSelitys
MAILPosti
TELEFAXFaksi
TELEPHONEPuhelin
LOCALPaikallinen
ESERVICESähköinen asiointi
SMSTekstiviesti
PRINTABLE_FORMTulostettava lomake

main_theme

Pääaihealueet:

Tyypin kooodiSelitys
CITY_AND_ADMINISTRATIONKaupunki ja hallinto
SOCIAL_AND_HEALTH_SERVICESSosiaali- ja terveyspalvelut
HOUSING_AND_ENVIRONMENTAsuminen ja ympäristö
CULTURE_AND_LEISUREKulttuuri ja vapaa-aika
DAY_CARE_AND_EDUCATIONPäivähoito ja koulutus
TRANSPORT_AND_MAPSLiikenne ja kartat

Hakutoiminnallisuudet

Palvelukuvauksia ja asiointipalveluja listaavissa kyselyissä on mahdollista käyttää hakuparametreja. Hakuparametrien avulla kyselystä palautuvien palvelukuvausten tai asiointipalvelujen joukkoa on mahdollista rajata halutulla tavalla. Hakuparametreja voi myös yhdistellä.

Hakuparametrit

search

Palvelukuvausten tai asiointipalvelujen etsiminen hakusanoilla.

Esimerkki. Palvelukuvaukset, joihin liittyy sana koira:http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?search=koira

department

Palvelunkuvausten tai asiointipalvelujen hakeminen vastaavan yksikön mukaan.

Esimerkki. Kaikki Helsingin Kaupunkiympäristön toimialan (85080572-9a95-4a18-be6b-5bc306eb3d85) asiointipalvelut: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?department=85080572-9a95-4a18-be6b-5bc306eb3d85

targetgroup

Palvelunkuvausten tai asiointipalvelujen etsiminen kohderyhmän mukaan

Esimerkki. Palvelukuvaukset palveluille, joiden kohderyhmä on nuoret (YOUTH): http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?targetgroup=YOUTH

errandservicetype

Palvelunkuvausten tai asiointipalvelujen etsiminen asiointipalvelun tyypin mukaan

Esimerkki. Asiointipalvelut, joiden tyyppi on ilmoitus (NOTICE): http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?errandservicetype=NOTICE

channeltype

Palvelunkuvausten tai asiointipalvelujen etsiminen palvelukanavan tyypin mukaan

Esimerkki. Asiointipalvelut, joilla on sähköinen asiointi tyyppinen (ESERVICE) palvelukanava: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?channeltype=ESERVICE

maintheme

Palvelunkuvausten tai asiointipalvelujen etsiminen tietyn pääaihealueen mukaan

Esimerkki. Palvelukuvaukset kulttuuri ja vapaa-aika (CULTURE_AND_LEISURE) aihealueen mukaan: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?maintheme=CULTURE_AND_LEISURE

description

Asiointipalvelujen etsiminen tietylle palvelukuvaukselle

Esimerkki. Asiointipalvelut palvelukuvaukselle 2484: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?description=2484

errandservice

Palvelukuvausten etsiminen tietylle asiointipalvelulle

Esimerkki. Palvelukuvaus asiointipalvelulle 506: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?errandservice=506

Hakuparametrien yhdistely

Kaikkia hakuparametreja on myös mahdollista yhdistellä tulosjoukon rajaamiseksi

Esimerkki. Kaikki asiointipalvelut joiden kohderyhmä on nuoret ja jolla on sähköinen asiointipalvelu tyyppisiä palvelukanavia: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?targetgroup=YOUTH&channeltype=ESERVICE