6Aika-palauterajapinnan määritelmä / Issue reporting API definition created by the six largest cities in Finland
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.yamllint.yaml
README.md
generate_graph.py
palaute-graph.gvt
palaute.swagger.yaml

README.md

Palauterajapinta, 6Aika

Palauterajapinta on avoin kaksisuuntainen REST-ohjelmointirajapinta (API). Rajapinnan kautta voi antaa kaupungille palautetta sekä seurata palautteen etenemistä. Rajapinnasta voi myös hakea annettuja palautteita.

Palauterajapinta perustuu kansainväliseen Open311-standardiin (http://www.open311.org), johon on tehty laajennuksia CitySDK- ja 6Aika-rajapintahankkeissa.

Tämä määritelmä kattaa 6Aika-kaupunkien yhteisen näkemyksen perustoiminnallisuuksista, joita palauterajapintaan tarvitaan. Yhteisellä määritelmällä pyritään varmistamaan, että eri rajapintatoteutukset ovat yhteensopivat. Kukin rajapinnan toteuttaja voi kehittää omaan rajapintaansa lisätoiminnallisuuksia tarpeidensa mukaan, kunhan rajapinta pysyy yhteensopivana 6Aika-määritelmän kanssa.

Määritelmän mukaisesti on tehty myös avoimen lähdekoodin referenssitoteus. Se löytyy osoitteesta https://github.com/6aika/issue-reporting.

6Aika-kaupungit kehittävät määritelmää jatkossakin yhdessä. Määritelmää koskevat kommentit ja kehitysehdotukset otetaan mielellään vastaan GitHubin issueina.

Issue reporting API, 6Aika

Issue reporting API is an open two way REST API. Issue reporting API allows to give feedback and follow the handling of the feedback through the API. You can also search for feedbacks through the API.

The Issue reporting API is based on the international Open 311 standard (http://www.open311.org/) with extensions made in the CitySDK and Six City (6Aika) projects.

This is a specification of basic features needed in an issue reporting API. The six largest cities in Finland created this specification with an aim to improve interoperability of issue reporting APIs across the globe. It is nevertheless possible for anyone interested in providing an issue reporting API to create features suitable for his/her own needs, as long as the API is interoperable with this specification.

Additionally, an open source reference API have been created according to the 6Aika-definition. The API created by the Six Cities according to this spec can be found via following link: https://github.com/6aika/issue-reporting.

The Six Cities are committed to further develop this definition in cooperation of the cities. Comments and development ideas regarding the definition are welcome as GitHub issues.