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

The Cities of Helsinki, Espoo, Vantaa and Kauniainen Service Register REST API

Terms and conditions for the Service Register REST API

You have the right to: On the following conditions:

Use of the interface and feedback on the interface

The interface offers possibilities to make queries and use the data in the Helsinki, Espoo, Vantaa and Kauniainen Service Register for your own web applications easily. 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 mirjam.heikkinen@hel.fi and henna.niemi@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]).

This is the first version of the interface and it includes search functionalities for service description and e-service queries.

What kind of queries can be made through the interface?

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

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
http://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. This has been documented below at the data models.

Example query to get the data of one data element
http://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: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/?municipality=91&language=en

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: http://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: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/description/2484/?format=xml

Description of data models

Service description

Example object of a single service description (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]}


Example object of a service description in a listing (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."}
AttributeValue explanation
idService description ID
main_descriptionIs it the main description (true) or the sub-description (false)
service_idService ID combining the main description and the sub-description
titleHeadline of the service description
name_synonymsSynonyms for the headline of the service description
description_shortShort service description (caption)
description_longService description
availability_summarySummary of the temporal availability of the service
prerequisitesPrerequisites for the use of the service
informationFurther information about the service
servicemap_urlService map URL
provided_languagesService languages
responsible_deptsDepartments 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_groupsTarget groups of the service (possible values under the "Typifications" headline)
life_eventsLife events of the service (possible values under the "Typifications" headline)
provider_typesAgreement types of the service (possible values under the "Typifications" headline)
errand_servicesList of e-services IDs associated with the entity of this service and similar services
exact_errand_servicesList of e-services IDs that you use in this exact service
linksList of links associated with the service as objects. The object includes the following fields: type, title, url, file_format.
availabilitiesList of temporal availabilities associated with the service as objects. The object includes the field availability_string.
unit_idsList 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 (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"}]}]}


Example of an e-service in a listing (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":[]}
AttributeValue explanation
idE-service ID
description_idService description ID
exact_descriptionsIDs of those service descriptions in which you engage with this e-service
service_idService ID combining the main description and the sub-description
typeType of e-service (possible values under the "Typifications" headline)
nameName of e-service
descriptionShort description of e-service
process_descriptionHow the processing of the matter advances
processing_timeProcessing time of the matter
expiration_timeExpiration time
costsCosts associated with the e-service
informationFurther information about the e-service
responsible_deptsDepartments 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.
linksList of links associated with the service as objects. The object includes the following fields: type, title, url, file_format.
channelsList 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.

AttributeValue explanation
idService channel ID
typeType of service channel (possible values under the "Typifications" headline)
type_stringType of service channel in text form
nameName of service channel
prerequisitesPrerequisites for the use of the service channel
informationFurther information about the service channel
availability_summarySummary of the temporal availability of the service channel
process_descriptionDescription of the service channel process
personal_service_street_addressPostal address or visiting address of the personal service channel
personal_service_postal_codePostal code of the personal service channel
personal_service_cityPost office of the personal service channel
phoneTelephone number of the service channel
faxTelefax number of the service channel
emailE-mail address of the service channel
form_numberForm number of the service channel
authorization_codeAuthorization code of the service channel
provided_languagesLanguages of the service channel
requires_authenticationDoes the service channel require identification (true/false)
saved_to_customer_folderIs the data saved in the customer folder (true/false)
e_processingIs the processing electronic (true/false)
e_decisionIs the decision available electronically (true/false)
payment_enabledIs payment possible (true/false)
for_personal_customerIs the service channel for personal customers (true/false)
for_corporate_customerIs the service channel for corporate customers (true/false)
linksList of links associated with the service channel as objects. The object includes the following fields: type, title, url, file_format.
availabilitiesList 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 (http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/searchword/?municipality=91):

{"search_word":"Ammatillinen peruskoulutus","weight":2}
AttributeValue explanation
search_wordSearch word
weightHow many service descriptions match the search word

Typifications

provider_type

Service producers, types of agreement:

Type codeExplanation
101Service produced by the municipality
102Service supported by the municipality
103Service produced by a joint municipal authority
104Service produced by the government
105Service produced by a private service producer

target_group

Target groups of the service:

Type codeExplanation
ASSOCIATIONSAssociations
CHILDREN_AND_FAMILIESChildren and families with children
YOUTHYoung people
ELDERLY_PEOPLEElderly people
DISABLEDDisabled
IMMIGRANTSImmigrants
ENTERPRISESEnterprises

errand_service_type

Types of e-services:

Type codeExplanation
NOTICENotice
APPOINTMENTAppointment
APPLICATIONApplication
ADVICEAdvice
COMMUNICATIONCommunications
ECOMMERCECommerce
ORDERINGOrder
INFORMATION_SERVICEInformation service
ENROLLMENTEnrollment
HEARINGHearing

channel_type

Service channel types:

Type codeExplanation
MAILMail
EMAILE-mail
TELEFAXTelefax
TELEPHONETelephone
SMSSMS
LOCALLocal service
CHATOnline chat
ESERVICEE-service
WEBPAGEWebpage
PRINTABLE_FORMPrintable form

main_theme

Main themes:

Type codeExplanation
CITY_AND_ADMINISTRATIONCity and administration
SOCIAL_AND_HEALTH_SERVICESSocial and health care services
HOUSING_AND_ENVIRONMENTHousing and the environment
CULTURE_AND_LEISURECulture and leisure
DAY_CARE_AND_EDUCATIONDay-care and education
TRANSPORT_AND_MAPSTransport 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):http://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: http://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): http://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): http://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: http://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: http://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: http://www.hel.fi/palvelukarttaws/rest/vpalvelurekisteri/errandservice/?description=2484

errandservice

Searching service description for a certain e-service

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

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