Prístupová url
https://odkazprestarostu.sk/api
API metódy
mestá | HTTPS GET
https://odkazprestarostu.sk/api/cities
Vráti zoznam aktívnych miest, v ktorých portál prevádzkujeme.
Parameters — žiadne
Príklad
{
"code": 1,
"cities": [
{
"id": "69",
"name": "Alekšince",
"city_part_count": "0",
"lat": "48.3669668",
"lng": "17.947471",
"typ": "1",
"event_count": "24"
},
{
"id": "19",
"name": "Babín",
"city_part_count": "0",
"lat": "49.3323414",
"lng": "19.3823568",
"typ": "1",
"event_count": "19"
}
...
]
}
Callback
- id — id príslušného mesta
- name — názov mesta
- city_part_count — { 0, 1 }
1 pokiaľ sa mesto delí na mestské časti
- lat, lng — geopozícia
- event_count — počet podnetov
mestské časti | HTTPS GET
https://odkazprestarostu.sk/api/city_parts
Vráti detaily mesta so zoznamom mestských častí
Parameters
- &city_id={id mesta} — id príslušného mesta
Príklad
{
"code": 1,
"city_parts":[
{
"id":"17",
"name":"\u010cunovo",
"city_id":"1",
"city":"Bratislava"
},
{
"id":"11",
"name":"Dev\u00edn",
"city_id":"1",
"city":"Bratislava"
},
...
]
}
Callback
- id — id mestskej časti
- name — názov mestskej časti
- city_id — id príslušného mesta
- city — názov mesta
zoznam podnetov | HTTPS GET
https://odkazprestarostu.sk/api/events_public
Vráti zoznam podnetov na základe zadaných parametrov. Všetky parametre sú nepovinné,
no zadaný musí byť aspoň jeden z nich. Pre podnety konkrétneho mesta zadáme ID mesta,
pre podnety špecifickej mestskej časti ID mestskej časti, pre podnety užívateľa jeho ID,
pre vyhľadávanie zadáme kľúčové slovo.
Parameters - vsetky parametre su nepovinne
- &city — id mesta
- & municipality — id samosprávy
- &city_part — id príslušnej mestskej časti
- &page — číslo strany
- &user — id užívateľa
- &status — { 1,2,3,7 } - stav riešenia podnetu
1 — vyriešený
2 — neriešený
3 — čaká sa na riešenie
7 — rozhodnite
- &order_by — { "date","last-response","last-updated","most-active","last-comment" } - moznost zoradenia podnetov
"date" — defaultné zoradenie podľa dátumu pridania
"last-response" — zoradnie podľa dátumu odpovede samozprávy
"last-updated" — zoradnie podľa naposledy aktualizovanývh podnetov
"most-active" — najaktívnejšie podnety za posledné obdobie
"last-comment" — zoradenie podľa posledného komentára
- &lat - Vyhľadávanie okolitých podnetov, ktoré su zoradené od najbližšieho podnetu (limit 100 podnetov)
- &lng - Vyhľadávanie okolitých podnetov, ktoré su zoradené od najbližšieho podnetu (limit 100 podnetov)
- &radius - Podnety vyhľadá v zadanom okruhu v kilometroch (default: 1km)
Príklad
{
"event_count": "63755",
"page_count": 4251,
"page": "1",
"events": [
{
"id": "77463",
"title": "Opletalova-riešenie dopravnej situácie-nebezpečné",
"image": "https:\/\/www.odkazprestarostu.sk\/image\/w552\/public\/alerts\/77463\/images\/5d6cd0219d584.jpg",
"description": "Po Opletalovej ulici dosť často jazdí kamiónová doprava, a to aj napriek napriek zákazom súčasným dopravným značením.\r\nProsím o riešenie situácie aj ďalšími opatreniami.",
"date": "pred 7 hodinami",
"timestamp": "1567412257",
"status": "Zaslané samospráve",
"status_id": "3",
"street": "Opletalova",
"competency": "Určuje sa",
"url": "https:\/\/www.odkazprestarostu.sk\/bratislava\/podnety\/77463\/opletalova-riesenie-dopravnej-situacie-nebezpecne",
"lat": "48.2226090000",
"lng": "16.9780860000",
"user_name": "Miša",
"user_id": "22582",
"user_level": 3,
"city": "Bratislava",
"city_id": "1",
"city_part_id": "12",
"city_part": "Devínska Nová Ves",
"distance": "unknown",
"comments": "0",
"vote_count": "0",
"category_id": "132",
}
...
]
}
Callback
- event_count — počet podnetov spolu
- page_count — počet podnetov na strane
- page — číslo strany
- events [ array ] - zoznam podnetov, pričom každý záznam obsahuje:
- id — id podnetu
- title — nadpis podnetu
- image — thumbnail fotografie podnetu
- description — popis podnetu
- date — dátum pridania podnetu v čitateľnom formáte
- timestamp — dátum pridania podnetu v UNIX čase
- status — stav riešenia podnetu vyjadrený slovom
- status_id — stav riešenia podnetu vyjadrený id
- street — názov ulice
- competency — subjekt zodpovedné za riešenie podnetu
- url — web url podnetu
- lat — latitude pozícia podnetu
- lng — longitude pozícia podnetu
- user_name — meno užívateľa, ktorý na podnet upozornil
- user_id — id užívateľa, ktorý na podnet upozornil
- user_level — level používateľa v systéme
- city — slovné vyjadrenie mesta, v ktorom sa podnet nachádza
- city_id — id mesta, v ktorom sa podnet nachádza
- city_part_id — id mestskej časti, v ktorej sa podnet nachádza
- city_part — slovné vyjadrenie mestskej časti, v ktorej sa podnet nachádza
- comments — počet komentárov k podnetu
- vote_count — počet hlasovaní za podnet
- category_id — id kategórie
detail podnetu | HTTPS GET
https://odkazprestarostu.sk/api/event_public
Vráti detail podnetu podľa zadaného ID.
Parameters
- &id — id podnetu (required)
Príklad
{
"status": 1,
"event": {
"id": "30965",
"title": "Poškodené dopravné značky",
"description": "Na Sídlisku Lúčna pri nových garážach je posprejovaná značka B 34 (zákaz zastavenia), ktorú je už takmer nevidieť za kríkom z vedľajšieho rodinného domu. Taktiež sa na danej križovatke z každej strany nachádzajú staré, nečitateľné a zhrdzavené dopravné značky označujúce hlavnú cestu a daj prednosť v jazde z vedľajšej cesty. Už na street view od google máp vidno, že v roku 2012 začínali hrdzavieť - http:\/\/ix.sk\/9uoaM .",
"date": "13. júl 2016",
"timestamp": "1468398999",
"status": "Vyriešený",
"status_id": "1",
"street": "Sídlisko Lúčna",
"competency": "Vranov nad Topľou",
"url": "https:\/\/odkazprestarostu.sk\/vranov-nad-toplou\/podnety\/30965\/poskodene-dopravne-znacky",
"lat": "48.8795465081",
"lng": "21.6986976014",
"user_name": "Matej",
"user_id": "3797",
"user_level": 15,
"city": "Vranov nad Topľou",
"city_id": "80",
"city_part_id": "0",
"city_part": "Vranov nad Topľou",
"follower_count": 0,
"vote_count": "1",
"category_id": "25",
"images": [
"https:\/\/www.odkazprestarostu.sk\/image\/w552\/public\/alerts\/30965\/images\/5785fd970a793.jpg"
],
"history": [
{
"type": "reply",
"content": {
"id": "64138",
"title": "Odpoveď samosprávy",
"user_id": null,
"text": "Podnet bol zaslaný na riešenie príslušnému oddeleniu.\r\n\r\nMgr. Eva Fedorňáková, hovorkyňa mesta",
"date": "19. júl 2016",
"time": "19. júl 2016",
"timestamp": "1468914342",
"icon": "https:\/\/odkazprestarostu.sk\/application\/images\/office.png",
"rating": 0
},
"images": []
},
{
"type": "news",
"content": {
"id": "14528",
"user_id": null,
"title": "Matej ",
"text": "Dopravná značka v smere od Kauflandu. Je aj dosť ďaleko od cesty kde ju zakrývajú aj zaparkované vozidlá.",
"date": "22. júl 2016",
"time": "22. júl 2016",
"timestamp": "1469176011",
"icon": "https:\/\/odkazprestarostu.sk\/img\/avatar_default.jpg",
"rating": 0
},
"images": [
"https:\/\/www.odkazprestarostu.sk\/image\/w528\/public\/alerts\/30965\/updates\/5791d8cec15e8.jpg"
]
}
...
],
"volunteer": null
}
}
Callback
- id — id podnetu
- title — nadpis podnetu
- description — popis podnetu zadaný užívateľom
- date — čitateľný dátum pridania podnetu
- timestamp — dátum pridania podnetu v UNIX čase
- status — stav riešenia podnetu vyjadrený slovom
- status_id — stav riešenia podnetu vyjadrený id
- street — názov ulice
- competency — subjekt zodpovedné za riešenie podnetu
- url — web url podnetu
- lat — latitude pozícia podnetu
- lng — longitude pozícia podnetu
- user_name — meno užívateľa, ktorý na podnet upozornil
- user_id — id užívateľa, ktorý na podnet upozornil
- user_level — level používateľa v systéme
- city — slovné vyjadrenie mesta, v ktorom sa podnet nachádza
- city_id — id mesta, v ktorom sa podnet nachádza
- city_part_id — id mestskej časti, v ktorej sa podnet nachádza
- city_part — slovné vyjadrenie mestskej časti, v ktorej sa podnet nachádza
- follower_count — počet ľudí, ktorí sledujú tento podnet
- vote_count — počet hlasov podnetu
- category_id — id kategórie
- images / array / - fotografie podnetu
- history / array poloziek historie obsahujuci: /
- type — news (aktualizácia od zadávateľa podnetu), reply (odpoveď samosprávy), comment (komentár používateľa)
- content
- id
- userid — id používateľa
- title
- text
- date
- time
- timestamp
- icon — icon používateľa
- rating — hodnotenie
- images (pole obrázkov v prílohe)
kategórie | HTTPS GET
https://odkazprestarostu.sk/api/categories
Vráti zoznam kategórií problémov
Príklad
{
"code":1,
"categories":[
{
"id":"16",
"name":"Cesty a chodn\u00edky",
"parent":null,
"description":"cesty, cyklotrasy, schody, oplotenie"
},
{
"id":"20",
"name":"stavby a budovy",
"parent":"21",
"description":""
},
...
]
}
Callback
- id — id príslušnej kategórie
- name — názov kategórie
- parent - nadradená kategória. Kategórie najvyššej úrovne majú parent=null
- description — popis kategórie
prihlásenie | HTTPS POST
https://odkazprestarostu.sk/api/login
Vráti informáciu o úspešnosti prihlásení.
HTTPS BASIC AUTH Parameters
- email - email používateľa (povinné)
- password - heslo používateľa (povinné)
Príklad
{
"code": 1,
"message": "Logged in as [email protected]",
"user": {
"id": "123465",
"first_name": "Janko",
"last_name": "Hraško",
"username": "[email protected]"
},
"access_token": "GAxVQ115iXjk3MzFaGGITERWsoaaDFDo"
}
Callback
- message — správa z API
- user — info o používateľovi
- access_token — Access Token používateľa, ktorým následne overuje requesty (napr. pridanie nového podnetu)
registrácia | HTTPS GET
https://odkazprestarostu.sk/api/register
Vytvorenie používateľa
Parameters
- email - email používateľa (povinné)
- password - heslo používateľa (povinné)
- first_name - krstné meno používateľa (povinné)
- last_name - priezvisko používateľa
Metóda vracia:
{
"code": 1,
"message": "Registered in as [email protected]",
"user": {
"id": 123456,
"first_name": "Janko",
"last_name": "Hraško",
"username": "[email protected]"
},
"access_token": "GAxVQ115iXjk3MzFaGGITERWsoaaDFDo"
}
Callback
- message — správa z API
- user — info o používateľovi
- access_token — Access Token používateľa, ktorým následne overuje requesty (napr. pridanie nového podnetu)
nový podnet | HTTPS POST
https://odkazprestarostu.sk/api/add_event
Pridanie podnetu pomocou HTTPS POST
HTTPS POST Parameters
- POST header: apitoken - API kľúč používateľa (povinné)
- description - textový popis podnetu (povinné)
- lat - geopozicia (povinné)
- lng - geopozicia (povinné)
- category_id - id kategorie podnetu (required, id podla metody #kategoria)
Metóda vracia:
{
"code": 1,
"event_id": 123
}
Callback
- event_id — id pridaného podnetu
nahranie obrázka k podnetu | HTTPS POST
https://odkazprestarostu.sk/api/upload_image
Pridanie obrázku k podnetu pomocou HTTPS POST (používateľ môže nahrať obrázok len k podnetu, ktorý vytvoril)
HTTPS POST Parameters
- POST header: apitoken - API kľúč používateľa (povinné)
- photo - zdroj obrázku vo formáte .png, .jpg, .gif, .jpeg (povinné)
- item_id - id podnetu, ku ktorému sa nahrá obrázok (povinné)
Príklad
{
"code": 1
}
...
{
"code": -506,
"message": "Invalid image format"
}
Callback
- code: 1 — v prípade úspešného nahratia obrázku
- code: záporný — v prípade chyby + chybová hláška