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

TPR Palvelukuvausrekisterin REST-rajapinta

Palvelukuvausrekisterin REST-rajapinnan käyttöehdot

Palvelukuvausrekisterin REST-rajapinnan tietoja saa käyttää Creative Commons 4.0 BY lisenssin käyttöehtojen mukaisesti.

Image of the Creative Commons 4.0 BY license

Sinulla on oikeus: Seuraavilla ehdoilla:

Rajapinnan käyttö ja palaute rajapinnasta

Rajapinta tarjoaa mahdollisuudet kysellä ja käyttää Helsingin, Espoon, Vantaan ja Kauniaisten kaupunkien sekä Länsi-Uudenmaan hyvinvointialueen ja Vantaan ja Keravan hyvinvointialueen Palvelukuvausrekisterin 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 osoitteisiin henna.niemi@hel.fi ja kati.seppala@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], 32213473 [Länsi-Uudenmaan hyvinvointialue], 32213561 [Vantaan ja Keravan hyvinvointialue]).

6/2021 - Lisätty uusi Generaldescription-objekti = valtion pohjakuvaukset (samalla Description-objektiin lisätty general_description_id)

5/2022 - Description ja Errandservice-objekteihin lisätty mahdollisuus parametriin alldata=yes, joka laajentaa listauksen tietomallin sarakemäärää.

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
https://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 (paitsi jos käytetään parametria alldata=yes). Tämä on dokumentoituna alempana tietomallien kohdalla.

Esimerkkikysely yhden tietoalkion tietojen saamiseksi
https://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: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?municipality=91&language=en
Tämä kysely palauttaa rajoitetumman listaus-tietomallin. Jos kyselyyn lisätään parametri alldata=yes, listauksen tietomalli laajenee vastaten yhden tietoalkion tietomallia.

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

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

Datamallien kuvaus

Palvelukuvaus

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

{"id":2484, "main_description":true, "service_id":10055, "title":"Varhaiskasvatus", "name_synonyms":"Varhaiskasvatus, päiväkotihoito", "description_short":"Varhaiskasvatusta tarjotaan sekä kunnallisena että yksityisenä palveluna päiväkodeissa, perhepäivähoidossa ja leikkitoiminnan kerhoissa.", "description_long":"Kasvatuksen ja koulutuksen toimiala vastaa suomen- ja ruotsinkielisestä varhaiskasvatuksesta. \n\nHelsingissä tarjotaan monipuolisesti myös avointa varhaiskasvatusta leikkipuistoissa ja perhetaloissa.", "information":"", "servicemap_url":"https://palvelukartta.hel.fi/fi/search?service_node=868&organization=83e74666-0836-4c1d-948a-4b34a8b90301", "general_description_id":"e4315af5-abcb-45a0-ab00-688e7ecd5313", "provided_languages":["en","fi","sv"], "responsible_depts":["cc70d1d8-3ca7-416a-9ea7-27e6b7ce58a8"], "target_groups":["CHILDREN_AND_FAMILIES"], "life_events":[], "errand_services":[506,4512], "exact_errand_services":[506,4512], "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/varhaiskasvatus/fi/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"}, {"type":"INTERNET", "title":"Esiopetus", "url":"https://www.hel.fi/helsinki/fi/kasvatus-ja-koulutus/paivahoito/esiopetus/", "file_format":"HTML"}], "availabilities":[], "unit_ids":[2,3,4,5,6,7,8,9,10,11,12,13,15,16,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,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,161,164,166,167,169,170,171,172,173, 174,175,176,177,178,181,182,183,185,187,188,189,190,191,192,193,194,195,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,265,266,267,268,269,270,271,272,273,274,276,277,278,279,280,281, 282,283,284,285,287,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,343,344,346,347,348,349,350,351,352,353,354,355,357,358,359,360,361,362,363,364,365,366,367,368,369,370,371,372,373,375,376,377,378,379,380,381,382,383,384,385, 386,387,388,389,391,392,393,395,396,404,409,410,413,414,415,416,417,418,419,421,422,423,424,425,426,429,430,431,432,433,434,437,440,442,443,445,446,448,449,450,458,462,464,465,468, 469,470,471,472,473,474,475,476,478,479,480,482,483,488,491,493,494,496,497,498,500,502,503,508,509,511,514,515,517,520,522,523,535,537,538,539,540,541,543,544,1986,2126,2199,2250, 2266,2321,2567,2592,2803,2863,2914,3086,3169,3438,3852,6500,6540,6561,6640,7240,7962,8401,8700,8860,8961,8980,9122,9123,9332,10402,10404,10405,10422,10563,10582,11342,11462,14442, 14483,14484,15962,16232,17343,17648,17763,17843,17845,18213,21455,21935,22725,22780,24196,24622,25392,25393,25444,25762,25763,25773,27447,27448,27475,28383,28384,28398,28399,29662, 29663,29842,29844,29849,29851,29854,29855,29859,29890,29918,29983,30032,30033,31009,31059,31179,31212,32245,32246,32306,32330,32398,32522,32898,32978,33339,33747,33748,33749,33750, 33751,33752,33753,34637,34638,34644,34645,34646,34710,34820,35270,35272,43328,43675,43677,43740,43743,43806,43809,43874,43875,43876,43877,43878,43879,44355,44392,44401,44461,44637, 44880,44885,45019,45587,45593,45963,46357,46377,46379,46470,46479,47784,47889,48870,48923,49017,50064,50065,50380,50381,50383,50384,50385,50579,51104,51312,52362,53052,53339,53345, 53377,53385,53422,53516,53518,54059,54094,54095,54096,54097,54098,54100,54412,54413,54414,54451,54455,54456,54457,54458,54493,54495,55401,55402,55883,55884,55947,56340,56548,56549, 56614,57025,57026,57117,57321,57402,57403,57469,57472,57474,57507,57571,57588,57643,57695,57839,57866,57971,58046,58455,58465,58520,58546,58689,59303,59304,59377,59426,59741,59878, 60090,60095,60730,60748,60783,60823,60828,60846,60864,60869,60870,61887,62050,62079,62675,62676,62677,62678,62933,62964,62998,63119,63120,63131,63145,63357,63358,63728,63811,63911, 63914,63915,63916,63917,63944,63951,63954]}


Esimerkkiobjekti palvelunkuvauksesta listauksessa, kun ei käytetä parametria alldata=yes (https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/):

{"id":2484,"main_description":true,"service_id":10055,"title":"Varhaiskasvatus","description_short":"Varhaiskasvatusta tarjotaan sekä kunnallisena että yksityisenä palveluna päiväkodeissa, perhepäivähoidossa ja leikkitoiminnan kerhoissa."}
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
general_description_idValtion pohjakuvauksen id, johon palvelukuvaus on liitetty. Koodit vastaavat vpalvelurekisteri/generaldescription-kyselyn kooditusta.
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)
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 (https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/4512):

{"id":4512,"exact_descriptions":[2484,8693],"service_id":10055,"type":"APPLICATION","name":"Varhaiskasvatushakemus Asti-asiointipalvelussa","description":"Huoltaja voi hakea lapselleen Helsingin kaupungin järjestämää varhaiskasvatusta ja esiopetusta Asti-asiointipalvelussa.\n\nKerhotoimintaan haetaan sähköisen asiointikansion kautta.\n","process_description":"Hakemuslomakkeessa on ohjeet lomakkeen täyttämisestä. Puuttuvat tai virheelliset tiedot näkyvät punaisella sivukohtaisesti.  \n\nHakemuksella pääsee siirtymään eteen päin kun kaikki pakolliset kentät on täytetty. Hakemuksen voi tallentaa luonnoksena ja luonnosta voi myöhemmin muokata. Luonnos poistuu, kun hakemus lähetetään. Lähettämisen jälkeen lomake on muokattavissa, kunnes se lukitaan, 3 kk ennen tarpeen alkua ja kiireellisessä tilanteessa nopeammin. \n \nLähetetty hakemus tallentuu Asti-asiointipalveluun. Palvelu ilmoittaa lähetyksen onnistumisesta. Hakija voi seurata hakemuksen tilaa järjestelmässä. Lähetetyn, käsittelyä odottavan hakemuksen tila on Lähetetty. Hakemusta voi muokata, kunnes hakemus lukitaan. Kun hakemus otetaan käsittelyyn, hakemuksen tilaksi muuttuu Käsittelyssä. \n \nVarhaiskasvatushakemukseen tehdään aina päätös tarpeen alkamispäivästä lähtien ja mahdollisuuksien mukaan perheen esittämistä vaihtoehdoista. \n \nPäätös varhaiskasvatuspaikasta on nähtävissä sähköisesti lapsen huoltajille Astissa.\n \nHakemus voidaan poistaa ennen päätöksen tekemistä. Poistetun hakemuksen tila on Poistettu. Se on silloin poistettu järjestelmästä.  \n \nKäsittelyaikana hakemukseen tulevista muutoksista ilmoitetaan soittamalla palveluohjaukseen.\n","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 kolme kuukautta ennen toivottua aloituspäivää.","expiration_time":"Hakemus on voimassa yhden vuoden lähetyspäivästä lukien.","costs":"Huomioi maksupäätöksen kansio \n\nMaksupäätökset toimitetaan toiseen Helsingin kaupungin sähköiseen asiointikansioon osoitteessa asiointi.hel.fi sille huoltajalle, joka on tehnyt hakemuksen. Tämä on siis eri järjestelmä, kun mihin varhaiskasvatuspäätös tulee ja huoltajan tulee katsoa asiakasmaksupäätöksiä sieltä.    \n","information":"Varhaiskasvatushakemuksen voi tehdä aikaisintaan vuotta ennen toivottua alkamispäivää.  \n  \nVarhaiskasvatuspaikkaa voi hakea myös Helsingin ulkopuolella asuvat. Paikan saamisen edellytyksenä on, että perheellä on varhaiskasvatuksen alkaessa kotipaikkana Helsinki. ","provided_languages":["en","fi","sv"],"responsible_depts":["cc70d1d8-3ca7-416a-9ea7-27e6b7ce58a8"],"target_groups":["CHILDREN_AND_FAMILIES"],"life_events":[],"links":[{"type":"INTERNET","title":"Asti","url":"https://asti.hel.fi"},{"type":"INTERNET","title":"Varhaiskasvatuksen palveluohjaus","url":"https://www.hel.fi/helsinki/fi/kasvatus-ja-koulutus/paivahoito/varhaiskasvatuksen-palveluohjaus/"}],"channels":[{"id":2871,"type":"ESERVICE","type_string":"Verkkoasiointi","name":"Täytä hakemus Asti-asiointipalvelussa","prerequisites":"Edellyttää tunnistamista joko henkilökohtaisilla verkkopankkitunnuksilla tai mobiilivarmenteella.\nPalvelu saatavilla joka päivä ympäri vuorokauden.","availability_summary":"Palvelu saatavilla joka päivä ympäri vuorokauden","provided_languages":["en","fi","sv"],"requires_authentication":true,"saved_to_customer_folder":true,"e_processing":true,"e_decision":true,"payment_enabled":false,"for_personal_customer":false,"for_corporate_customer":false,"links":[{"type":"INTERNET","title":"Siirry hakemukseen","url":"https://asti.hel.fi","file_format":"HTML"}],"availabilities":[{"availability_string":"Palvelu saatavilla joka päivä ympäri vuorokauden"}]}]}


Esimerkkiobjekti asiointipalvelusta listauksessa, kun ei käytetä parametria alldata=yes (https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/):

{"id":4512,"service_id":10055,"type":"APPLICATION","name":"Varhaiskasvatushakemus Asti-asiointipalvelussa","description":"Huoltaja voi hakea lapselleen Helsingin kaupungin järjestämää varhaiskasvatusta ja esiopetusta Asti-asiointipalvelussa.\n\nKerhotoimintaan haetaan sähköisen asiointikansion kautta.\n","process_description":"Hakemuslomakkeessa on ohjeet lomakkeen täyttämisestä. Puuttuvat tai virheelliset tiedot näkyvät punaisella sivukohtaisesti.  \n\nHakemuksella pääsee siirtymään eteen päin kun kaikki pakolliset kentät on täytetty. Hakemuksen voi tallentaa luonnoksena ja luonnosta voi myöhemmin muokata. Luonnos poistuu, kun hakemus lähetetään. Lähettämisen jälkeen lomake on muokattavissa, kunnes se lukitaan, 3 kk ennen tarpeen alkua ja kiireellisessä tilanteessa nopeammin. \n \nLähetetty hakemus tallentuu Asti-asiointipalveluun. Palvelu ilmoittaa lähetyksen onnistumisesta. Hakija voi seurata hakemuksen tilaa järjestelmässä. Lähetetyn, käsittelyä odottavan hakemuksen tila on Lähetetty. Hakemusta voi muokata, kunnes hakemus lukitaan. Kun hakemus otetaan käsittelyyn, hakemuksen tilaksi muuttuu Käsittelyssä. \n \nVarhaiskasvatushakemukseen tehdään aina päätös tarpeen alkamispäivästä lähtien ja mahdollisuuksien mukaan perheen esittämistä vaihtoehdoista. \n \nPäätös varhaiskasvatuspaikasta on nähtävissä sähköisesti lapsen huoltajille Astissa.\n \nHakemus voidaan poistaa ennen päätöksen tekemistä. Poistetun hakemuksen tila on Poistettu. Se on silloin poistettu järjestelmästä.  \n \nKäsittelyaikana hakemukseen tulevista muutoksista ilmoitetaan soittamalla palveluohjaukseen.\n","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 kolme kuukautta ennen toivottua aloituspäivää.","expiration_time":"Hakemus on voimassa yhden vuoden lähetyspäivästä lukien.","costs":"Huomioi maksupäätöksen kansio \n\nMaksupäätökset toimitetaan toiseen Helsingin kaupungin sähköiseen asiointikansioon osoitteessa asiointi.hel.fi sille huoltajalle, joka on tehnyt hakemuksen. Tämä on siis eri järjestelmä, kun mihin varhaiskasvatuspäätös tulee ja huoltajan tulee katsoa asiakasmaksupäätöksiä sieltä.    \n","information":"Varhaiskasvatushakemuksen voi tehdä aikaisintaan vuotta ennen toivottua alkamispäivää.  \n  \nVarhaiskasvatuspaikkaa voi hakea myös Helsingin ulkopuolella asuvat. Paikan saamisen edellytyksenä on, että perheellä on varhaiskasvatuksen 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
name_synonymsAsiointipalvelun nimen synonyymit
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_addrHenkilökohtaisen palvelukanavan posti- tai käyntiosoite
personal_service_postal_codeHenkilökohtaisen palvelukanavan postinumero
personal_service_cityHenkilökohtaisen palvelukanavan postitoimipaikka
phonePalvelukanavan puhelinnumero
call_charge_infoPuhelinnumeron maksullisuus
faxPalvelukanavan faksinumero
emailPalvelukanavan sähköpostiosoite
form_numberPalvelukanavan lomakkeen numero
authorization_codePalvelukanavan valtuuskoodin nimi
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 (https://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

Valtion pohjakuvaus

Esimerkkiobjekti yksittäisestä valtion pohjakuvauksesta - käytä language-parametria, jos haluat pohjakuvauksen ruotsiksi tai englanniksi (https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/generaldescription/e4315af5-abcb-45a0-ab00-688e7ecd5313):

{"id":"e4315af5-abcb-45a0-ab00-688e7ecd5313","type":"Service","service_charge_type":"Chargeable","name":"Varhaiskasvatus kunnallisessa päiväkodissa","description_short":"Varhaiskasvatuksen yhtenä toimintamuotona on päiväkotitoiminta, jota järjestetään päiväkodissa.","description_long":"Varhaiskasvatuksen yhtenä toimintamuotona on päiväkotitoiminta, jota järjestetään päiväkodissa.\n\nVarhaiskasvatuksen tavoitteena on tukea lapsen kasvua, kehitystä ja oppimista sekä edistää hänen hyvinvointiaan. Jokaiselle lapselle laaditaan päiväkodissa varhaiskasvatussuunnitelma. \n\nKunnallinen päiväkotihoito voi olla joko kokopäiväistä tai osapäiväistä.","prerequisites":"Varhaiskasvatusta voi saada lapsi, joka ei ole vielä oppivelvollinen. \n\nMyös oppivelvollisuusikäinen voi saada varhaiskasvatusta, jos erityiset olosuhteet sitä vaativat eikä hoitoa voi muuten järjestää.","user_instruction":"Hae varhaiskasvatuspaikkaa lapselle viimeistään neljä kuukautta ennen päivähoidossa aloittamista.","deadline":null,"validity_time":null,"processing_time":null,"charge_info":"Maksun suuruuteen vaikuttavat perheen koko, tulot ja hoitopäivien pituus.","additional_info":null}


Esimerkkiobjekti valtion pohjakuvauksesta listauksessa (https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/generaldescription/):

{"id":"e4315af5-abcb-45a0-ab00-688e7ecd5313","type":"Service","service_charge_type":"Chargeable","name":"Varhaiskasvatus kunnallisessa päiväkodissa","description_short":"Varhaiskasvatuksen yhtenä toimintamuotona on päiväkotitoiminta, jota järjestetään päiväkodissa.","description_long":"Varhaiskasvatuksen yhtenä toimintamuotona on päiväkotitoiminta, jota järjestetään päiväkodissa.\n\nVarhaiskasvatuksen tavoitteena on tukea lapsen kasvua, kehitystä ja oppimista sekä edistää hänen hyvinvointiaan. Jokaiselle lapselle laaditaan päiväkodissa varhaiskasvatussuunnitelma. \n\nKunnallinen päiväkotihoito voi olla joko kokopäiväistä tai osapäiväistä.","prerequisites":"Varhaiskasvatusta voi saada lapsi, joka ei ole vielä oppivelvollinen. \n\nMyös oppivelvollisuusikäinen voi saada varhaiskasvatusta, jos erityiset olosuhteet sitä vaativat eikä hoitoa voi muuten järjestää.","user_instruction":"Hae varhaiskasvatuspaikkaa lapselle viimeistään neljä kuukautta ennen päivähoidossa aloittamista.","deadline":null,"validity_time":null,"processing_time":null,"charge_info":"Maksun suuruuteen vaikuttavat perheen koko, tulot ja hoitopäivien pituus.","additional_info":null}
AttribuuttiArvon selitys
idValtion pohjakuvauksen tunniste
typeValtion pohjakuvauksen tyyppi
service_charge_typeValtion pohjakuvauksen maksullisuuden tyyppi
nameValtion pohjakuvauksen nimi
description_shortLyhyt kuvaus
description_longPitkä kuvaus
prerequisitesKäytön edellytykset
user_instructionToimintaohje
deadlineAikaraja
validity_timeVoimassaoloaika
processing_timeKäsittelyaika
charge_infoMaksutiedot
additional_infoLisätiedot

Tyypitykset

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
EMAILSähköposti
TELEFAXFaksi
TELEPHONEPuhelin
SMSTekstiviesti
LOCALPaikallinen, henkilökohtainen palvelu
CHATChatti, päätekeskustelu
ESERVICESähköinen asiointi
WEBPAGEVerkkosivu
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:https://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: https://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): https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?targetgroup=YOUTH

errandservicetype

Palvelunkuvausten tai asiointipalvelujen etsiminen asiointipalvelun tyypin mukaan

Esimerkki. Asiointipalvelut, joiden tyyppi on ilmoitus (NOTICE): https://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: https://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: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?maintheme=CULTURE_AND_LEISURE

description

Asiointipalvelujen etsiminen tietylle palvelukuvaukselle

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

errandservice

Palvelukuvausten etsiminen tietylle asiointipalvelulle

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

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: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?targetgroup=YOUTH&channeltype=ESERVICE