Suomeksi | See also REST API for City of Helsinki Service Map

TPR Service Description Register REST API

Terms and conditions for the Service Description Register REST API

Information from the Service Description Register REST API may be used in accordance with the terms of use of the Creative Commons 4.0 BY license.

Image of the Creative Commons 4.0 BY license

You have the right to:

Share – copy, distribute, show and present data.
Remix – prepare revised works based on the data.
Both non-commercial and commercial use is allowed.

On the following conditions:

The TPR Service Description Register shall be mentioned as the administrator of the interface of the data collected from the interface.
The provider of the Service Description Register interface shall not be held liable for the up-to-dateness and correctness of the data collected through the interface. The user of the interface uses the data of the Service Description Register on their own responsibility. The City of Helsinki shall not be held liable for any direct or indirect damage caused by the use of the Service Description Register data. The City of Helsinki shall also not be held liable for any damages caused by service breaks in the Service Description Register API.
The name of the creator of the data set, or the service from which the data set has been collected, may not be used without permission for advertising or marketing software or a service based on the data set.

Use of the interface and feedback on the interface

The interface offers the possibility to easily query and use information from the Service Description Register of the cities of Helsinki, Espoo, Vantaa and Kauniainen, as well as the Wellbeing services county of Vantaa and Kerava and county of Western Uusimaa in your own online applications. The interface has been developed in accordance with the REST models and you make date queries in either JSON or XML format.

We welcome feedback on the interface and on how you utilise the interface in your projects. You can send your feedback by e-mail to henna.niemi@hel.fi and kati.seppala@hel.fi.

Publication history

5/2013 - first version published

11/2014 - unit_ids added to Description object. Includes ID codes for service points connected to the description. The codes are in accordance with the coding of the REST interface of the City of Helsinki Service Map and Service Point Register.

6/2017 - possibility to limit results with a municipality parameter added to the Description and Errandservice objects (municipality=91 is default [Helsinki], others 49 [Espoo], 92 [Vantaa], 235 [Kauniainen], 32213561 [Wellbeing services county of Vantaa and Kerava], 32213473 [Wellbeing services county of Western Uusimaa]).

6/2021 - new Generaldescription object = state's descriptions ordered by law (also general_description_id added to Description object)

5/2022 - new parameter alldata=yes added to the Description and Errandservice objects that broadens the data model of a listing query (to contain the same fields as in the one object query)

What kind of queries can be made through the interface?

Through the interface, it is possible to make the following kinds of data queries:

Service descriptions arranged by municipalities and wellbeing services counties
Service-related e-services
Service channels of e-services
Search words relating to the service descriptions
General descriptions of the state ordered by law

Making data queries from the interface

Data queries can be made either one data element at the time - or as listings, which returns the data on all data elements in question at once.

Addresses from which queries can be made are formed in the following way:

Example query to list all data elements
https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/

The above-mentioned query creates a list of all of Helsinki's public service descriptions as JSON objects (Helsinki's service descriptions is the default; if you want Espoo's service descriptions, use the parameter municipality=49). It must be noted that in the data models, a data model of a listing is more restricted than a data model of a one object query (unless you use the parameter alldata=yes). This has been documented below at the data models.

Example query to get the data of one data element
https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484

The above query returns the data of a service description with the id = 2484.

The interface returns data elements in Finnish by default. If you want to search for data in other languages, use the language parameter, which can take the values of fi, sv, en, fi2, sv2 and en2 (last three are plain language versions).
Example: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?municipality=91&language=en
This query returns (restricted) listing data model. With the parameter alldata=yes, the listing data model will be broader and contain the same fields as the one object query.

The interface returns data in JSON format by default and supports JSONP query, if you want to add a callback parameter to the query.
Example: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484/?callback=foo

If the data is wanted in XML format, then it is possible to add the format=xml parameter to the query.
Example: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484/?format=xml

Description of data models

Service description

Example object of a single service description (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]} Example object of a service description in a listing without parameter 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."}

Attribute	Value explanation
id	Service description ID
main_description	Is it the main description (true) or the sub-description (false)
service_id	Service ID combining the main description and the sub-description
title	Headline of the service description
name_synonyms	Synonyms for the headline of the service description
description_short	Short service description (caption)
description_long	Service description
availability_summary	Summary of the temporal availability of the service
prerequisites	Prerequisites for the use of the service
information	Further information about the service
servicemap_url	Service map URL
general_description_id	General description id, to which Service description is connected. The code is in accordance with the vpalvelurekisteri/generaldescription query coding.
provided_languages	Service languages
responsible_depts	Departments responsible for the service. The codes of the departments are in accordance with the v4/department query coding of the REST interface of the City of Helsinki Service Map and Service Point Register.
target_groups	Target groups of the service (possible values under the "Typifications" headline)
life_events	Life events of the service (possible values under the "Typifications" headline)
errand_services	List of e-services IDs associated with the entity of this service and similar services
exact_errand_services	List of e-services IDs that you use in this exact service
links	List of links associated with the service as objects. The object includes the following fields: type, title, url, file_format.
availabilities	List of temporal availabilities associated with the service as objects. The object includes the field availability_string.
unit_ids	List of service point ID codes, which this service description concerns. The ID codes are in accordance with the coding of the REST interface of the City of Helsinki Service Map and Service Point Register.

E-service

Example object of a single e-service (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"}]}]} Example of an e-service in a listing without parameter 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":[]}

Attribute	Value explanation
id	E-service ID
description_id	Service description ID
exact_descriptions	IDs of those service descriptions in which you engage with this e-service
service_id	Service ID combining the main description and the sub-description
type	Type of e-service (possible values under the "Typifications" headline)
name	Name of e-service
name_synonyms	Name synonyms of e-service
description	Short description of e-service
process_description	How the processing of the matter advances
processing_time	Processing time of the matter
expiration_time	Expiration time
costs	Costs associated with the e-service
information	Further information about the e-service
responsible_depts	Departments responsible for the service The unit codes are in accordance with the v4/department query coding of the REST interface of the City of Helsinki Service Map and Service Point Register.
links	List of links associated with the service as objects. The object includes the following fields: type, title, url, file_format.
channels	List of the e-service's service channels as objects. The channel's object has been described in its own chapter.

Service channel

The service channels are always associated with some e-service, which is why service channels cannot be searched separately but only as part of the e-service.

Attribute	Value explanation
id	Service channel ID
type	Type of service channel (possible values under the "Typifications" headline)
type_string	Type of service channel in text form
name	Name of service channel
prerequisites	Prerequisites for the use of the service channel
information	Further information about the service channel
availability_summary	Summary of the temporal availability of the service channel
process_description	Description of the service channel process
personal_service_street_addr	Postal address or visiting address of the personal service channel
personal_service_postal_code	Postal code of the personal service channel
personal_service_city	Post office of the personal service channel
phone	Telephone number of the service channel
call_charge_info	Charges attached to the telephone number
fax	Telefax number of the service channel
email	E-mail address of the service channel
form_number	Form number of the service channel
authorization_code	Authorization code of the service channel
provided_languages	Languages of the service channel
requires_authentication	Does the service channel require identification (true/false)
saved_to_customer_folder	Is the data saved in the customer folder (true/false)
e_processing	Is the processing electronic (true/false)
e_decision	Is the decision available electronically (true/false)
payment_enabled	Is payment possible (true/false)
for_personal_customer	Is the service channel for personal customers (true/false)
for_corporate_customer	Is the service channel for corporate customers (true/false)
links	List of links associated with the service channel as objects. The object includes the following fields: type, title, url, file_format.
availabilities	List of temporal availabilities associated with the service channel as objects. The object includes the field availability_string.

Search word

Listing of the search words associated with the City's service descriptions. The search words are formed of the names and synonyms of the service descriptions (default value is municipality=91 [Helsinki], others 49 [Espoo], 92 [Vantaa], 235 [Kauniainen]).

Example object of a single search word (https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/searchword/?municipality=91): {"search_word":"Ammatillinen peruskoulutus","weight":2}

Attribute	Value explanation
search_word	Search word
weight	How many service descriptions match the search word

General description

Example object of a single general description - use language parameter to get Swedish and English versions (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} Example of a general description in a listing (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}

Attribute	Value explanation
id	General description ID
type	General description type
service_charge_type	General description charge type
name	Name of General description
description_short	Short general description (caption)
description_long	General description
prerequisites	Prerequisites for the use of the service ordered by law
user_instruction	User instructions for the use of the service ordered by law
deadline	Deadline
validity_time	Validity time
processing_time	Processing time of the matter
charge_info	Information about charges attached to the service ordered by law
additional_info	Further information about the service

Typifications

target_group

Target groups of the service:

Type code	Explanation
ASSOCIATIONS	Associations
CHILDREN_AND_FAMILIES	Children and families with children
YOUTH	Young people
ELDERLY_PEOPLE	Elderly people
DISABLED	Disabled
IMMIGRANTS	Immigrants
ENTERPRISES	Enterprises

errand_service_type

Types of e-services:

Type code	Explanation
NOTICE	Notice
APPOINTMENT	Appointment
APPLICATION	Application
ADVICE	Advice
COMMUNICATION	Communications
ECOMMERCE	Commerce
ORDERING	Order
INFORMATION_SERVICE	Information service
ENROLLMENT	Enrollment
HEARING	Hearing

channel_type

Service channel types:

Type code	Explanation
MAIL	Mail
EMAIL	E-mail
TELEFAX	Telefax
TELEPHONE	Telephone
SMS	SMS
LOCAL	Local service
CHAT	Online chat
ESERVICE	E-service
WEBPAGE	Webpage
PRINTABLE_FORM	Printable form

main_theme

Main themes:

Type code	Explanation
CITY_AND_ADMINISTRATION	City and administration
SOCIAL_AND_HEALTH_SERVICES	Social and health care services
HOUSING_AND_ENVIRONMENT	Housing and the environment
CULTURE_AND_LEISURE	Culture and leisure
DAY_CARE_AND_EDUCATION	Day-care and education
TRANSPORT_AND_MAPS	Transport and maps

Search functionalities

In queries that list service descriptions and e-services, it is possible to use search parameters. When using search parameters, the group of service descriptions or e-services resulting from a query can be limited according to your requirements. Search parameters can also be combined.

Search parameters

search

Making service description or e-service queries using search words.

Example. Service descriptions, which contain the word koira (dog):https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?search=koira

department

Searching service descriptions or e-services according to the corresponding department.

Example. All e-services of the City of Helsinki (85080572-9a95-4a18-be6b-5bc306eb3d85) Urban Environment Division: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?department=85080572-9a95-4a18-be6b-5bc306eb3d85

targetgroup

Searching for service descriptions or e-services according to target group.

Example. Service descriptions for services whose target group consists of young people (YOUTH): https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?targetgroup=YOUTH

errandservicetype

Searching for service descriptions or e-services according to type of e-service.

Example. E-services whose type is notice (NOTICE): https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?errandservicetype=NOTICE

channeltype

Searching for service descriptions or e-services according to type of service channel.

Example. E-services which have an e-services type (ESERVICE) of service channel: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?channeltype=ESERVICE

maintheme

Searching for service descriptions or e-services according to a certain main theme.

Example. Service descriptions according to the culture and leisure (CULTURE_AND_LEISURE) theme: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?maintheme=CULTURE_AND_LEISURE

description

Searching e-services for a certain service description

Example. E-services for service description 2484: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?description=2484

errandservice

Searching service description for a certain e-service

Example. Service description for e-service 4512: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?errandservice=4512

Combining search parameters

All search parameters can also be combined to limit the result group.

Example. All e-services whose target group consists of young people and which have service channels of the e-service type: https://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?targetgroup=YOUTH&channeltype=ESERVICE