Для разработчиков

Данный раздел предназначен для сторонних разработчиков. Здесь публикуются материалы, которые могут помочь при разработке сторонних клиентских программ и сервисов.

StreetJournal API (Level 1)

Получить список проблем в заданном радиусе от указанной точки.
url: <host>/myterra/api/issuelist

Параметры

user	email пользователя, указанный им при регистрации на портале
pswd	пароль
latitude	широта
longitude	долгота
radius	радиус окружности в метрах (если отсутствует, то по умолчанию 1000 метров)

Кодировка

Кодировка запроса	UTF-8
Content-type ответа	text/xml;charset=UTF-8

Типичный ответ

<Response> <Item Status="1" Id="17813" Name="Яма на дороге" Lat="58.00104429952269" Lng="56.24918377026918" Dt="15.09.2010 19:54:12" Text="Очень большая яма на дороге. Я попал туда левым колесом" Author="Andr"/> ..</Response>

Комментарий

Поле Status может иметь одно из следующих значений:

• 1 - проблема открыта
• 2 - проблема принята к исполнению
• 3 - проблема закрыта
• 4 - проблема в архиве

Поле Dt определяет дату и время в формате dd.mm.yy hh:mm:ss. В поле записано время в часовом поясе UTC+0. При использовании требуется локализация.

Пример вызова

http://10.15.1.37/myterra/api/issuelist?User=lan@gelicon.biz&Pswd=admin&Latitude=58.00104429952269&Longitude=56.24918377026918&Radius=3000

Получить список категорий.
uri: <host>/myterra/api/catlist

Параметры

user	email пользователя, указанный им при регистрации на портале
pswd	пароль

Кодировка

Кодировка запроса	UTF-8
Content-type ответа	text/xml;charset=UTF-8

Типичный ответ

<Response> <Item Id="52" Group="Безопасность" Name="бесхозные объекты, лица без ОМЖ"/> ..</Response>

Пример вызова

http://10.15.1.37/myterra/api/catlist?User=lan@gelicon.biz&Pswd=admin

Добавить комментарий
uri: <host>/myterra/api/addcomment

Параметры

user	email пользователя, указанный им при регистрации на портале
pswd	пароль
id	идентификатор проблемы
text	текст коментария
anonymous	флаг анонимности (true или false)
photo	картинка, в кодировке base64

Кодировка

Кодировка запроса	UTF-8
Content-type ответа	text/xml;charset=UTF-8

Типичный ответ

<Response><Comment Id="18867"/></Response>

Аттрибут Id содержит идентификатор вновь добавленного комментария.

Добавить проблему
uri: <host>/myterra/api/addissue

Параметры

user	email пользователя, указанный им при регистрации на портале
pswd	пароль
latitude	широта
longitude	долгота
name	проблема (кратко)
address	адрес
text	проблема (подробно)
anonymous	флаг анонимности (true или false)
categorylist	идентификаторы категорий (целые числа через разделитель. В качестве разделителя - запятая)
photo	картинка, в кодировке base64

Кодировка

Кодировка запроса	UTF-8
Content-type ответа	text/xml;charset=UTF-8

Типичный ответ

<Response><Issue Id="18867"/></Response>

Аттрибут Id содержит идентификатор вновь добавленной проблемы.

Получение компонент адреса из строки адреса(геокодинг)
uri: <host>/myterra/api/geocode

Параметры

user	email пользователя, указанный им при регистрации на портале
pswd	пароль
lat	широта
lng	долгота

Кодировка

Кодировка запроса	UTF-8
Content-type ответа	text/xml;charset=UTF-8

Типичный ответ

<Response> <place address="ул. Лебедева, 31/12, город Пермь, Пермский край, Россия, 614017"> <area address="город Пермь, Пермский край, Россия" name="город Пермь"/> <country address="Россия" name="Россия"/> <district address="Мотовилихинский Адм. район, город Пермь, Пермский край, Россия" name="Мотовилихинский Адм. район" /> <region address="город Пермь, Пермский край, Россия" name="Пермский край" /> </place></Response>

<Response> <place address="Волгоградский просп., 46ГС1, город Москва, Россия"> <area address="город Москва, Россия" name="город Москва"/> <subarea address="АО Юго-Восточный, город Москва, Россия" name="АО Юго-Восточный"/> <country address="Россия" name="Россия"/> <district address="Печатники, город Москва, Россия" name="Печатники"/> </place></Response>

<Response> <place address="Ильинский район, Пермский край, Россия"> <country address="Россия" name="Россия"/> <region address="Пермский край, Россия" name="Пермский край"/> <subregion address="Ильинский район, Пермский край, Россия" name="Ильинский район"/> </place></Response>

Элементы area, subarea, district, region и subregion могут отсутствовать. Каждый элемент включает следующие атрибуты: address - адрес, описывающий область, name - название, которое нужно будет сохранить в соответствующее поле, описывающее расположение проблемы.

Обработка ошибок

Ошибки возвращаются в виде xml следующей структуры

<Fault><Message>Краткое сообщение об ошибке</Message><StackTrace>![CDATA[Стек ошибки на сервере]]</StackTrace></Fault>

Кодировка

Типичный ответ

<Fault> <Message>Пользователь не найден или пароль указан неверно</Message> <StackTrace><![CDATA[java.lang.Exception: Пользователь не найден или пароль указан неверноat apiHandler.authenticate(apiHandler.java:435)at apiHandler.catlist(apiHandler.java:237)at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)at java.lang.reflect.Method.invoke(Method.java:597)at apiHandler.doRequest(apiHandler.java:103)at gelicon.cms.AbstractHandler.submit(AbstractHandler.java:62)at ServiceClass.FormResource.writeToResponse(FormResource.java:10)at Servlets.GServlet.doGet(GServlet.java:262)at javax.servlet.http.HttpServlet.service(HttpServlet.java:617)at javax.servlet.http.HttpServlet.service(HttpServlet.java:717)at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:290)at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233)at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191)at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:128)at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:102)at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:293)at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:849)at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:583)at org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:454)at java.lang.Thread.run(Thread.java:619) ]]></StackTrace> </Fault>