Определение географических координат населенных пунктов

Материал из Map.BY
(Различия между версиями)
Перейти к: навигация, поиск
 
Строка 4: Строка 4:
  
 
http://map.by/map/getCityCoordinates/{:city}
 
http://map.by/map/getCityCoordinates/{:city}
Параметр Описание
+
{| class="wikitable"
{:city} Наименование города. Параметр должен быть передан в виде urlencode(строка, в которой все не цифробуквенные символы, кроме -_. заменены знаком процента (%), за которым следует два шестнадцатеричных числа, а пробелы кодируются как знак сложения (+) Формат кодировки – UTF8
+
|-
 +
! Параметр !! Описание
 +
|-
 +
|{:city} || Наименование города. Параметр должен быть передан в виде urlencode(строка, в которой все не цифробуквенные символы, кроме -_. заменены знаком процента (%), за которым следует два шестнадцатеричных числа, а пробелы кодируются как знак сложения (+) Формат кодировки – UTF8
 +
|}
 +
 
 
В случае успеха сервис вернет JSON код в виде:
 
В случае успеха сервис вернет JSON код в виде:
 
+
<source lang="javascript">
 
{"status":"found","coord":{"x":"30.0256516239468","y":"52.8906787038684","place":"city"}}
 
{"status":"found","coord":{"x":"30.0256516239468","y":"52.8906787038684","place":"city"}}
Параметр Описание
+
</source>
status
+
Статус ответа. Может принимать 2 варианта значений:
+
  
found – в случае успешного выполнения запроса
+
{| class="wikitable"
not_found– в случае неудачного выполнения запроса
+
|-
coord
+
! Параметр !! Описание
Массив, содержащий в себе параметры ответа:
+
|-
 +
| status || Статус ответа. Может принимать 2 варианта значений:
 +
* ''found'' – в случае успешного выполнения запроса
 +
* ''not_found'' – в случае неудачного выполнения запроса
 +
|-
 +
|coord || Массив, содержащий в себе параметры ответа:
 +
* ''x'' – координата X
 +
* ''y'' – координата Y
 +
* ''place'' – тип найденого населенного пункта:
 +
** city – город
 +
** place
 +
** locality
 +
** isolated_dwelling
 +
** allotments
 +
** hamlet
 +
** town
 +
** island
 +
** islet
 +
** village
 +
** suburb
 +
|}
  
x – координата X
 
y – координата Y
 
place– тип найденого населенного пункта:
 
city – город
 
place
 
locality
 
isolated_dwelling
 
allotments
 
hamlet
 
town
 
island
 
islet
 
village
 
suburb
 
 
Если поиск завершится неудачей (записей не найдено), сервис вернет JSON нотификацию об ошибке в виде:
 
Если поиск завершится неудачей (записей не найдено), сервис вернет JSON нотификацию об ошибке в виде:
 
+
<source lang="javascript">
 
{"status":"not_found"}
 
{"status":"not_found"}
 +
</source>
 
Пример использования:
 
Пример использования:
  
Строка 41: Строка 51:
  
 
RESPONSE:
 
RESPONSE:
 +
<source lang="javascript">
 
{"status":"found","coord":{"x":"30.0256516239468","y":"52.8906787038684","place":"city"
 
{"status":"found","coord":{"x":"30.0256516239468","y":"52.8906787038684","place":"city"
Подробнее: http://map.by/API.htm
+
</source>

Текущая версия на 12:11, 11 сентября 2012

Описание: Интерфейс служит для определения географических координат указанного населенного пункта по его названию.

Параметры использования: Функция вызывается при помощи сформированного GETзапроса по указанному URL. Данные возвращаются в формате JSON.

http://map.by/map/getCityCoordinates/{:city}

Параметр Описание
{:city} Наименование города. Параметр должен быть передан в виде urlencode(строка, в которой все не цифробуквенные символы, кроме -_. заменены знаком процента (%), за которым следует два шестнадцатеричных числа, а пробелы кодируются как знак сложения (+) Формат кодировки – UTF8

В случае успеха сервис вернет JSON код в виде:

{"status":"found","coord":{"x":"30.0256516239468","y":"52.8906787038684","place":"city"}}
Параметр Описание
status Статус ответа. Может принимать 2 варианта значений:
  • found – в случае успешного выполнения запроса
  • not_found – в случае неудачного выполнения запроса
coord Массив, содержащий в себе параметры ответа:
  • x – координата X
  • y – координата Y
  • place – тип найденого населенного пункта:
    • city – город
    • place
    • locality
    • isolated_dwelling
    • allotments
    • hamlet
    • town
    • island
    • islet
    • village
    • suburb

Если поиск завершится неудачей (записей не найдено), сервис вернет JSON нотификацию об ошибке в виде:

{"status":"not_found"}

Пример использования:

REQUEST: http://map.by/map/getCityCoordinates/%D0%96%D0%BB%D0%BE%D0%B1%D0%B8%D0%BD

RESPONSE:

{"status":"found","coord":{"x":"30.0256516239468","y":"52.8906787038684","place":"city"
Личные инструменты
Пространства имён

Варианты
Действия
Навигация
Инструменты