Miejskie Centrum Kontaktu - 19115

Transkrypt

MiejskieCentrumKontaktu-19115
APIumożliwiazgłaszanieprzezmieszkańcówiodwiedzającychstolicęinformacjioawariach,
usterkach i niekrytycznych zagrożeniach dotyczących np. stanu jezdni, odśnieżania, szkód,
aktów wandalizmu, itp. API umożliwia także uzyskanie selektywne informacji według
podanegofiltru.
ZbiórdanychzostałudostępnionyprzezBiuroInformatykiiCentrumKomunikacjiSpołecznej
Identyfikatorzasobu(resource_id)
Dostępdozbiorudanych:resource_id=(28dc65ad-fff5-447b-99a3-95b71b4a7d1e)
MetodaHTTP
GET
19115-wyszukiwaniepoparametrach
http://api.um.warszawa.pl/api/action/19115store_getNotifications
Parametrywywołania
•
Id–identyfikatorzasobu(uwagawartośćidpodanawdokumentacjimożebyć
przykładowa–poprawneidprzydzielonedoposzczególnychzasobówzawiera
portalapi.um.warszawa.pl)
•
apikey-identyfikatordostępudoAPI(dostępdotegozasobuwymagarejestracji
naportaluapi.um.warszawa.plipobraniawartościapikey)
•
filters<filters>:Filtrynazgłoszeniachoparametrachfield,operatorivalue
o Field:
-
DISTRICT("district")
-
DEVICE_TYPE("deviceType")
-
STREET("street")
-
SUBCATEGORY("subcategory")
-
EVENT("event")
1
-
CREATE_DATE("createDate")
-
NOTIFICATION_NAME("notificationName")
-
TYPE("type")
-
SOURCE_TYPE("sourceType")
o Operator–operatory
-
EQ("eq")
-
NEQ("neq")
-
LT("lt")
-
GT("gt")
-
LEQ("leq")
-
GEQ("geq")
o Value-wyszukiwanawartość
•<operators>:Operatorynazgłoszeniach:
o AND(„and”)
o OR(„or”)
Strukturaodpowiedzi
Odpowiedź(NotificationResponse)
•
<notifications>:Listazgłoszeń:
o siebelEventId–identyfikatorzdarzeniawsystemieCKM
o deviceType–typurządzenia,zapomocąktóregozostałodokonanezgłoszenie
o street–ulicazesłownikasystemuCKM
o street2–ulicazgłoszenia
o district–dzielnicazgłoszenia
o city–miastozgłoszenia
o aparmentNumber–numermieszkaniazgłoszenia
o category–kategoriazgłoszenia
o subcategory–podkategoriazgłoszenia(wartośćsłownikowa,jakprzyzgłaszaniu)
o event–procesinterwencyjny(wartośćsłownikowa,jakprzyzgłaszaniu)
o createDate–datautworzenia
2
notificationNumber–numerzgłoszenia
xCoordWGS84-SzerokośćgeograficznazgłoszeniawstandardzieWGS84
yCoordWGS84-¬-DługośćgeograficznazgłoszeniawstandardzieWGS84
xCoordOracle-¬-SzerokośćgeograficznazgłoszeniawstandardzieOracleSpatial
yCoordOracle-¬-DługośćgeograficznazgłoszeniawstandardzieOracleSpatial
notificationType–typzgłoszenia
- INCIDENT("Awaria/Interwencja")
- INFORMATIONAL("Informacyjne")
- COMPLAINT("Reklamacja")
- STATUS("Statussprawy/zgłoszenia")
- PUBLIC_INFORMATION("Wniosekodostępdoinformacjipublicznej")
- FREEFORM("Wolnewnioskiiuwagi")
o <statuses>–listastatusówzgłoszenia
- changeDate–datazmianystatusu
- status–nazwastatusu(np.Nowe,Wtrakcie,Zamknięte)
- description–opisstatusu
o Source–źródłozgłoszenia
- API("API")
- CALL("CALL")
- CKM("CKM")
- MAIL("MAIL")
- MOBILE("MOBILE")
- PHONE("Phone")
- PORTAL("PORTAL")
- SMS("SMS")
- WEB("Web")
- WEBCHAT("WEBCHAT")
- EMPTY("brak")
o
o
o
o
o
o
•
•
responseCode:Kododpowiedzi-wyszczególnionewpunkcieKodybłędów.
responseDesc:TokenOpisodpowiedzi-opisbłęduwprzypadkuniepoprawnej
odpowiedzi
Przykład
3
PrzykładowewywołaniezparametremfiltersipolemDISTRICT=Wola
http://api.um.warszawa.pl/api/action/19115store_getNotifications?id=28dc65ad-fff5447b-99a395b71b4a7d1e&filters=%22filters%22%3A[{%22field%22%3A%22DISTRICT%22%2C%22oper
ator%22%3A%22EQ%22%2C%22value%22%3A%22Wola%22}]&operators=%22operators%2
2%3Anull&apikey=wartosc
19115–wyszukiwaniezgłoszeńwedługokresu
http://api.um.warszawa.pl/api/action/19115store_getNotificationsForDate
Parametrywywołania
•
•
•
•
Id – identyfikator zasobu (uwaga wartość id podana w dokumentacji może być
przykładowa–poprawneidprzydzielonedoposzczególnychzasobówzawieraportal
api.um.warszawa.pl)
apikey-identyfikatordostępudoAPI(dostępdotegozasobuwymagarejestracjina
portaluapi.um.warszawa.plipobraniawartościapikey)
dateFrom:Początekokresuwyszukiwanychzgłoszeń–wyszukiwanienastępujepo
daciestworzeniazgłoszenia(beztejdaty,wykorzystanyjestoperatorwiększości).
dateTo:Koniecokresuwyszukiwanychzgłoszeń--wyszukiwanienastępujepodacie
stworzeniazgłoszenia(beztejdaty,wykorzystanyjestoperatormniejszości).
dateFrom,dateTo–datawformacieUNIX(long-reprezentującymczasw
milisekundach,któryupłynąłod01.01.1970UTC)
Odpowiedź–jw.
Przykład:
http://api.um.warszawa.pl/api/action/19115store_getNotificationsForDate?id=28dc65adfff5-447b-99a395b71b4a7d1e&dateFrom=1427088587865&dateTo=1427361387865&apikey=wartosc
19115getnotificationsfordistrictWyszukiwaniezgłoszeńdladzielnicy
http://api.um.warszawa.pl/api/action/19115store_getNotificationsForDistrict
4
Parametrywywołania
•
•
•
api.um.warszawa.pl)
district:Nazwadzielnicy,którejdotyczyzgłoszenie.
Odpowiedź–jw.
Przykład:
http://api.um.warszawa.pl/api/action/19115store_getNotificationsForDistrict?id=28dc65ad
-fff5-447b-99a3-95b71b4a7d1e&district=Wola&apikey=wartosc
19115-wyszukiwaniezgłoszeńponumerzezgłoszenia
http://api.um.warszawa.pl/api/action/19115store_getNotificationsForNotificationNumber
Parametrywywołania
•
•
•
api.um.warszawa.pl)
notificationNumber:Numerzgłoszenia.
Odpowiedź–jw.
Przykład:
http://api.um.warszawa.pl/api/action/19115store_getNotificationsForNotificationNumber?i
d=28dc65ad-fff5-447b-99a3-95b71b4a7d1e&notificationNumber=123/45&apikey=wartosc
19115-zgłoszeniewolnegowniosku
http://api.um.warszawa.pl/api/action/19115store_sendFreeform
5
Parametrywywołania
•
•
•
•
•
•
•
api.um.warszawa.pl)
description:Opiszgłoszenia(wymagany).
email:E--mailzgłaszającego.
lastName:Nazwiskozgłaszającego.
name:Imięzgłaszającego--ustawianewopcjachaplikacji.
phoneNumber:Numertelefonuzgłaszającego.
Odpowiedź(SendNotificationResponse):
• responseCode:Kododpowiedzi-wyszczególnionewpunkcieKodybłędów.
• responseDesc:Opisodpowiedzi-opisbłęduwprzypadkuniepoprawnej
odpowiedzi.
• correlationId:Tymczasowyidentyfikatorzgłoszenia.
Przykład
http://api.um.warszawa.pl/api/action/19115store_sendFreeform?id=28dc65ad-fff5-447b99a395b71b4a7d1e&[email protected]&name=test&lastName=test&phoneNumber=5001
00200&description=test&apikey=wartosc
19115-zgłoszenieinformacyjne
http://api.um.warszawa.pl/api/action/19115store_sendInformational
Parametrywywołania
•
•
•
•
•
api.um.warszawa.pl)
6
•
•
odpowiedzi.
Przykłady
http://api.um.warszawa.pl/api/action/19115store_sendInformational?id=28dc65ad-fff5447b-99a395b71b4a7d1e&[email protected]&name=test&lastName=test&phoneNumber=5001
00200&description=test&apikey=wartosc
19115-zgłoszenieawarii/interwencji
http://api.um.warszawa.pl/api/action/19115store_sendIncident
Parametrywywołania
•
•
•
•
•
•
•
•
api.um.warszawa.pl)
subcategory:Kategoriazgłoszenia(wyamgany)--wybórjednejzwartości
o roadsDrogi,
o transportationKomunikacja,
otherInne,
o housing-Lokalowe,
o snowremoval-Odśnieżanie,
o garbageŚmieci
o damageUszkodzenie,dewastacja,
7
•
•
•
•
•
o greeneryZieleń,
o waterWodno--kanalizacyjne,
o animalsZwierzęta.
event:Procesinterwencyjny(wymagany)wybórjednejzwartościsłownikowej
(mapowanieznajdujesięwTabela1):
o ip_roads_001
o ip_roads_002
o ip_roads_003
o ip_roads_004
o ip_roads_005
o ip_roads_006
o ip_transportation_001
o ip_housing_001
o ip_housing_002
o ip_garbage_001
o ip_garbage_002
o ip_garbage_003
o ip_damage_001
o ip_damage_002
o ip_damage_004
o ip_greenery_001
o ip_water_001
o ip_water_002
o ip_water_003
o ip_water_004
o ip_animals_001
o ip_animals_002
o ip_animals_003
o ip_others_001
o ip_snowremoval_001
xCoordWGS84:Szerokośćgeograficznazgłoszenia(wymagany)-napodstawie
lokalizacjiwprowadzanejnamapiepodczastworzeniazgłoszenia.
yCoordWGS84:Długośćgeograficznazgłoszenia(wymagany)-napodstawie
lokalizacjiwprowadzanejnamapiepodczastworzeniazgłoszenia.
street:Ulicazgłoszenia(wymagany)–dookreślenialokalizacjizgłoszenia.
houseNumber–numerbudynkumiejscazgłoszenia
8
• aparmentNumber–numermieszkaniamiejscazgłoszenia
odpowiedzi.
Przykład:
http://api.um.warszawa.pl/api/action/19115store_sendIncident?id=28dc65ad-fff5-447b99a395b71b4a7d1e&[email protected]&name=test&lastName=test&phoneNumber=5001
00200&description=test&xCoordWGS84=54&yCoordWGS84=74&subcategory=other&eventT
ype=ip_other_001&street=lipowa&houseNumber=1&aparmentNumber=1&apikey=wartosc
MetodyHTTP
POST
19115getnotificationsPOST
http://api.um.warszawa.pl/api/action/19115store_getNotificationsPost
Parametrywywołania
•
•
api.um.warszawa.pl)
POST:
http://api.um.warszawa.pl/api/action/19115store_getNotificationsPost?id=28dc65ad-fff5447b-99a3-95b71b4a7d1e&apikey=wartosc–danefilters/operatorszakodowanejakoJSON
zgodniezespecyfikacjąAPI19115
Przykład
WywołaniewyszukiwaniawdzielnicyWolaIpodkategoriiDrogi:
9
{"filters":[{"field":"SOURCE_TYPE","operator":"EQ","value":"WOLA"},{"field":"SUBCATEGOR
Y","operator":"EQ","value":"roads"}],"operators":["AND"]}
19115–wysłaniepowiadomieniaozdarzeniu
http://api.um.warszawa.pl/api/action/19115store_sendIncidentPost
Parametrywywołania
•
•
api.um.warszawa.pl)
POSThttp://api.um.warszawa.pl/api/action/19115store_sendIncidentPost?id=28dc65adfff5-447b-99a3-95b71b4a7d1e&apikey=wartosc
incidentdataencodedinJSONcontentencodedinJSONcontentaccordingAPI19115
spec(canbeadditionalphotoBase64parameterwhichisnotavailableviaGET)
Przykład:
{"email":"[email protected]","name":"Jan","lastName":"Kowalski","phoneNumber":"XXXXXX
XXX"
,"xCoordWGS84":"55","yCoordWGS84":"72","description":"opis","subcategory":"OTHER","e
ven
tType":"IP_OTHER_001","street":"Warszawska","houseNumber":"2","aparmentNumber":"1
"}
Kod
Procesinterwencyjny
ip_roads_001
Zgłoszenieuszkodzeniachodnika,ścieżkirowerowej,lubwykruszenia
nawierzchnijezdni
ip_roads_002
Uszkodzeniesygnalizacjiświetlnej
ip_roads_003
Uszkodzenielatarni
ip_roads_004
Zgłoszenieonielegalnymzajęciupasadrogi
ip_roads_005
Uszkodzenielubbrakurządzeńróżnychzamontowanychwjezdniach,
chodnikach
10
ip_roads_006
Czasowazmianaorganizacjiruchu
ip_transportation_001 ZTM-zgłoszenieprzepełnieniapojazdówkomunikacjimiejskiej,uwagi
dotyczącekursowaniapojazdów
ip_transportation_003 ZTM-niewłaściwezachowanieprowadzącychpojazdykomunikacji
miejskiej
ip_transportation_004 ZTM-sprawyzwiązanezfunkcjonowaniemautomatówbiletowych
ip_transportation_005 ZTM-zażalenienastantechnicznypojazdu
ip_housing_001
Awariaogrzewaniawlokalukomunalnym
ip_housing_002
Odpadającytynk,przeciekającydach
ip_garbage_001
Zalegającenieczystościwmiejscachpublicznych
ip_garbage_002
Odbiórniezgodnyzharmonogramem
ip_garbage_003
Przepełnieniepojemników/worków
ip_garbage_004
Niedostarczonopojemnika/worka
ip_garbage_005
Zmianaczęstotliwościodbioru
ip_garbage_006
Źleoznakowanepojemniki
ip_garbage_007
Wymianauszkodzonegopojemnika
ip_garbage_008
Stansanitarnypojemników
ip_garbage_009
Braknieruchomościwharmonogramie
ip_garbage_010
Odpadyzielone
ip_garbage_011
Przepełnionaaltankaśmietnikowa
ip_damage_001
Zdewastowanyprzystanek
ip_damage_002
Placezabaw,ławki,kosze-dewastacjaurządzeń
ip_damage_004
Graffiti
ip_greenery_001
Zgłoszenieinterwencjiwzakresiezieleniprzyulicznej,parkowej
ip_water_001
Brakwody
11
ip_water_002
Uszkodzenielubbrakurządzeńróżnych-zamontowanychwjezdniach,
chodnikach
ip_water_003
Nieprzyjemny,uciążliwyzapach
ip_water_004
Brakodpływuścieków
ip_animals_001
Martwezwierzęta
ip_animals_002
Zdarzeniadot.zwierzynydzikożyjącej-leśnej
ip_animals_003
Szczurywmiejscachpublicznych
ip_others_001
Innezdarzenie
ip_snowremoval_001
Nieodśnieżonychodnik(śliskichodnik,śniegnachodniku,ulicy)
ip_snowremoval_002
Soplenabudynkach
ip_snowremoval_003
Nieodśnieżonyprzystanek
ip_snowremoval_004
Śniegnabudynkach
Tabela1.Mapowanieprocesówinterwencyjnych.
12
METADANE
Parametr
CKM19115
Identyfikator
7ad5c04d-1d3d-400b-af3c-50244e381d2c
Tytuł
CKM19115
Groups
bezpieczeństwoiinterwencje
Opis
API umożliwia zgłaszanie przez mieszkańców i odwiedzających
stolicę informacji o awariach, usterkach i niekrytycznych
zagrożeniach dotyczących np. stanu jezdni, odśnieżania, szkód,
aktówwandalizmu,itp.APIumożliwiatakżeuzyskanieselektywne
informacjiwedługpodanegofiltru.
Tags
Awaria,usterka,zagrożenie,interwencja,zgłoszenie
License
Licencja
Organizacja
CKS
Status
danych
zbioru Publiczny
Źródło
Systemzgłoszeniowy19115API
Wersja
1.0
Autor
e-mailautora
Opiekun
e-mailopiekuna
Extrafields
13

Miejskie Centrum Kontaktu - 19115

Transkrypt

Podobne dokumenty

Mobile + Kontekst Otoczenia

Instrukcja integracji HP Wall Art ze stroną www

Pobierz zasób - Dane Publiczne