Oma kaupunki API 4.10.2011 Oma kaupunki API... 1 Johdanto... 2 Toiminnallisuudet... 2 Kaikkien tapahtumien hakeminen... 2... 2 Yksittäisen tapahtuman hakeminen... 2... 3... 3 Tapahtumakategorioiden hakeminen... 3... 3 Yksittäisen tapahtumakategorian hakeminen... 3... 4... 4 Tapahtumien hakeminen hakukriteerin avulla... 4... 4... 4 Kaikkien palveluiden hakeminen... 5... 5 Yksittäisen palvelun hakeminen... 5... 5... 5 Palvelukategorioiden hakeminen... 6... 6 Yksittäisen palvelukategorian hakeminen... 6... 6... 6 Palveluiden hakeminen hakukriteerin avulla... 7... 7... 7 Esimerkkihaku... 7 1
Johdanto Oman kaupungin rajapinnan kautta saa käyttöön Oman kaupungin palveluiden ja tapahtumien tiedot. Rajapinta on read- only ja tarvitsee toimiakseen API- avaimen käytön, jonka saa rekisteröitymällä sovelluksen tekijäksi osoitteessa http://api.omakaupunki.fi. Rajapinta palauttaa JSON- tietueen. Rajapinnan (versio 1) osoite on http://api.omakaupunki.fi/v1/. Toiminnallisuudet Kaikkien tapahtumien hakeminen /event Haku palauttaa kaikki tapahtumat. Perusjärjestys on uusimmasta vanhimpaan. "pagination": "page": 1, "body": "Dj:t Bommitommi, Enrico ja VG+ sekä Komposti Sound - dj:t.", "title": "Dance on the Corner", "http://omakaupunki.fi/sornainen/tapahtumat/dance_on_the_corner.9/", "created_at": 1304989145, "id": 63213, "end_time": 1305939600, "start_time": 1305918000, "body": "Livenä Signmark ja Species Traitor. Dj:t Anna CCCCC, Unelmavävy ja Multitunes. Viittomakielinen tulkkaus.", "title": "Utopia", "http://omakaupunki.fi/sornainen/tapahtumat/utopia.5/", "created_at": 1304989145, "id": 63212, "end_time": 1305921600, "start_time": 1305903600 Yksittäisen tapahtuman hakeminen /event/id Haku palauttaa yksittäisen tapahtuman tiedot. 2
id pakollinen Tapahtuman id. "body": "Dj:t Bommitommi, Enrico ja VG+ sekä Komposti Sound - dj:t.", "title": "Dance on the Corner", "http://omakaupunki.fi/sornainen/tapahtumat/dance_on_the_corner.9/", "created_at": 1304989145, "id": 63213, "end_time": 1305939600, "start_time": 1305918000 Tapahtumakategorioiden hakeminen /event/categories Haku palauttaa tapahtumakategoriat. "http://omakaupunki.fi/paakaupunkiseutu/tapahtumat/kategoria/keilailu /", "plural": "Keilailua", "id": 108, "parent": 3, "name": "Keilailu", "http://omakaupunki.fi/paakaupunkiseutu/tapahtumat/kategoria/tanssi/", "plural": "Tanssi", "id": 1, "parent": null, "name": "Tanssi" Yksittäisen tapahtumakategorian hakeminen /event/categories/id 3
Haku palauttaa yksittäisen tapahtumakategorian tiedot. id pakollinen Tapahtumakategorian id. "http://omakaupunki.fi/paakaupunkiseutu/tapahtumat/kategoria/keilailu /", "plural": "Keilailua", "id": 108, "parent": 3, "name": "Keilailu" Tapahtumien hakeminen hakukriteerin avulla /event/search Haku palauttaa hakua vastaavat tapahtumat. area category text Haettava alue. Jokin seuraavista: paakaupunkiseutu (oletusarvo), helsinki, vantaa, espoo. Haettava tapahtumakategorian id. Vapaa tekstihaku "title": "Perusnäyttelyssä Suomen luonto, Maailman luonto, Elämän historia ja Luut kertovat", "http://omakaupunki.fi/kamppi/tapahtumat/perusnayttelyssa_suomen_luon to_maailman_luonto_elaman/", "start_time": 1211403630, "lon": 24.9312201216, "end_time": 1327960770, "lat": 60.1708588517, "id": 39119 4
Kaikkien palveluiden hakeminen /directory Haku palauttaa kaikki palvelut. Perusjärjestys on uusimmasta vanhimpaan. "pagination": "page": 1, "description": "Skrimondo on psykologipalveluita tarjoava yritys, joka on erikoistunut terapeuttisen kirjoittamisen yksilö- ja ryhmäohjaukseen. ", "title": "Skrimondo", "http://omakaupunki.fi/pikkuhuopalahti/palvelut/skrimondo/", "created_at": 1304928355, "phone": "0451162655", "category_id": 90, "id": 17228, "description": "Aito Suomalainen kylä/lähiöbaari. Elävää musiikkia,biljardi,tikka ym.\nmahdollisuus järjestää kemuja,synnttäreitä,ym.\nsoita ja kysy lisää", "title": "pub/baari", "http://omakaupunki.fi/kannelmaki/palvelut/pubbaari/", "created_at": 1304852693, "phone": "041 7108775", "category_id": 214, "id": 17227 Yksittäisen palvelun hakeminen /directory/id Haku palauttaa yksittäisen palvelun. id pakollinen Palvelun id. "description": "Aito Suomalainen kylä/lähiöbaari. Elävää musiikkia,biljardi,tikka ym.\nmahdollisuus järjestää kemuja,synnttäreitä,ym.\nsoita ja kysy lisää", "title": "pub/baari", 5
"http://omakaupunki.fi/kannelmaki/palvelut/pubbaari/", "created_at": 1304852693, "phone": "041 7108775", "category_id": 214, "id": 17227 Palvelukategorioiden hakeminen /directory/categories Haku palauttaa palvelukategoriat. "http://omakaupunki.fi/paakaupunkiseutu/palvelut/kategoria/kirkko/", "plural": "Kirkot", "id": 172, "parent": 171, "name": "Kirkko", "http://omakaupunki.fi/paakaupunkiseutu/palvelut/kategoria/hautausmaa /", "plural": "Hautausmaat", "id": 173, "parent": 171, "name": "Hautausmaa" Yksittäisen palvelukategorian hakeminen /directory/categories/id Haku palauttaa yksittäisen palvelukategorian. id pakollinen Palvelukategorian id. "http://omakaupunki.fi/paakaupunkiseutu/palvelut/kategoria/kirkko/", "plural": "Kirkot", "id": 172, "parent": 171, "name": "Kirkko" 6
Palveluiden hakeminen hakukriteerin avulla /directory/search Haku palauttaa hakukriteerejä vastaavat palvelut. area category text Haettava alue. Jokin seuraavista: paakaupunkiseutu (oletusarvo), helsinki, vantaa, espoo. Haettava palvelukategorian id. Vapaa tekstihaku "lat": 60.2483649619, "http://omakaupunki.fi/malmi/palvelut/1685680/", "lon": 25.0101394298, "id": 8501, "title": "A A Lukkokeskus Oy 24h", "lat": 60.17977907879602, "http://omakaupunki.fi/toolo/palvelut/134064074/", "lon": 24.923867422922402, "id": 14949, "title": "A la Carte -keittiöt Helsinki Töölö" Esimerkkihaku http://api.omakaupunki.fi/v1/event/1?api_key=apikey http://api.omakaupunki.fi/v1/event/categories?api_key=apikey 7
8