Yksittäisen tapahtumakategorian hakeminen... 3 Parametrit... 4 Vastausesimerkki... 4 Tapahtumien hakeminen hakukriteerin avulla...

Transkriptio

1 Oma kaupunki API Oma kaupunki API... 1 Johdanto... 2 Toiminnallisuudet... 2 Kaikkien tapahtumien hakeminen Yksittäisen tapahtuman hakeminen Tapahtumakategorioiden hakeminen Yksittäisen tapahtumakategorian hakeminen Tapahtumien hakeminen hakukriteerin avulla Kaikkien palveluiden hakeminen Yksittäisen palvelun hakeminen Palvelukategorioiden hakeminen Yksittäisen palvelukategorian hakeminen Palveluiden hakeminen hakukriteerin avulla Esimerkkihaku

2 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 Rajapinta palauttaa JSON- tietueen. Rajapinnan (versio 1) osoite on 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", " "created_at": , "id": 63213, "end_time": , "start_time": , "body": "Livenä Signmark ja Species Traitor. Dj:t Anna CCCCC, Unelmavävy ja Multitunes. Viittomakielinen tulkkaus.", "title": "Utopia", " "created_at": , "id": 63212, "end_time": , "start_time": Yksittäisen tapahtuman hakeminen /event/id Haku palauttaa yksittäisen tapahtuman tiedot. 2

3 id pakollinen Tapahtuman id. "body": "Dj:t Bommitommi, Enrico ja VG+ sekä Komposti Sound - dj:t.", "title": "Dance on the Corner", " "created_at": , "id": 63213, "end_time": , "start_time": Tapahtumakategorioiden hakeminen /event/categories Haku palauttaa tapahtumakategoriat. " /", "plural": "Keilailua", "id": 108, "parent": 3, "name": "Keilailu", " "plural": "Tanssi", "id": 1, "parent": null, "name": "Tanssi" Yksittäisen tapahtumakategorian hakeminen /event/categories/id 3

4 Haku palauttaa yksittäisen tapahtumakategorian tiedot. id pakollinen Tapahtumakategorian id. " /", "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", " to_maailman_luonto_elaman/", "start_time": , "lon": , "end_time": , "lat": , "id":

5 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", " "created_at": , "phone": " ", "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", " "created_at": , "phone": " ", "category_id": 214, "id": 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

6 " "created_at": , "phone": " ", "category_id": 214, "id": Palvelukategorioiden hakeminen /directory/categories Haku palauttaa palvelukategoriat. " "plural": "Kirkot", "id": 172, "parent": 171, "name": "Kirkko", " /", "plural": "Hautausmaat", "id": 173, "parent": 171, "name": "Hautausmaa" Yksittäisen palvelukategorian hakeminen /directory/categories/id Haku palauttaa yksittäisen palvelukategorian. id pakollinen Palvelukategorian id. " "plural": "Kirkot", "id": 172, "parent": 171, "name": "Kirkko" 6

7 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": , " "lon": , "id": 8501, "title": "A A Lukkokeskus Oy 24h", "lat": , " "lon": , "id": 14949, "title": "A la Carte -keittiöt Helsinki Töölö" Esimerkkihaku 7

8 8