Адрес службы: POST

http://api.alemtat.kz/web/{ext}/Catalog/GetCitiesAsync


Поиск населенного пункта по имени

Информация о запросе

URI параметры

НаименованиеОписаниеТипДополнительная информация
ext

Формат данных. JSON или XML.

 string

Нет описания

Параметры запроса

НаименованиеОписаниеТипДополнительная информация
CityName

Наименование населенного пункта

 string

Нет описания
CountryLocalCode

Локальный код страны, если нужно искать город в определенной стране (необязательный)

 string

Нет описания
ApiKey

Выданный API-ключ

 string

Обязательный

Используется для получения доступа к данным

Форматы запроса

application/json, text/json

Пример: 
{
  "CityName": "sample string 1",
  "CountryLocalCode": "sample string 2"
}

application/xml, text/xml

Пример: 
<ParamCities xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <CityName>sample string 1</CityName>
  <CountryLocalCode>sample string 2</CountryLocalCode>
</ParamCities>

Примеры кода

$.ajax({
    type: 'POST',
    url: 'http://api.alemtat.kz/web/json/catalog/GetCitiesAsync',
    dataType: 'json',
    data: { ApiKey: 'Выданный API-ключ', CityName: 'Алматы' }
	success: function (data) {
        console.log(data);
    },
    error: function(xhr, status) {
        console.log(xhr.status + ': ' + xhr.statusText);
    }
});
$kv = array();
$kv['CityName'] = 'Алматы';
$kv['ApiKey'] = 'Выданный API-ключ';
$postdata = http_build_query($kv);
$opts = array('http' =>
	array(
	    'method'  => 'POST',
	    'header'  => 'Content-type: application/x-www-form-urlencoded',
	    'content' => $postdata
	)
);
$context = stream_context_create($opts);
$result = file_get_contents('http://api.alemtat.kz/web/json/catalog/GetCitiesAsync', false, $context);
echo $result;

Информация об ответе

Описание ответа

НаименованиеОписаниеТипДополнительная информация
LocalCode

Локальный код населенного пункта

 string

Нет описания
LocalityName

Наименование населенного пункта

 string

Нет описания
LocalityNameKaz

Наименование населенного пункта на каз.

 string

Нет описания
ILocalityName

Международное наименование населенного пункта

 string

Нет описания
CountryLocalCode

Локальный код страны

 string

Нет описания
Country

Страна

 string

Нет описания
RegionLocalCode

Локальный код региона

 string

Нет описания
Region

Регион

 string

Нет описания
ICode

Код ИАТА

 string

Нет описания
LocalityTypeName

Тип населенного пункта

 string

Нет описания
KATO

Классификатор административно-территориальных объектов

 string

Нет описания

Форматы ответа

application/json, text/json

Пример: 
[
  {
    "LocalCode": "sample string 1",
    "LocalityName": "sample string 2",
    "LocalityNameKaz": "sample string 3",
    "ILocalityName": "sample string 4",
    "CountryLocalCode": "sample string 5",
    "Country": "sample string 6",
    "RegionLocalCode": "sample string 7",
    "Region": "sample string 8",
    "ICode": "sample string 9",
    "LocalityTypeName": "sample string 10",
    "KATO": "sample string 11"
  },
  {
    "LocalCode": "sample string 1",
    "LocalityName": "sample string 2",
    "LocalityNameKaz": "sample string 3",
    "ILocalityName": "sample string 4",
    "CountryLocalCode": "sample string 5",
    "Country": "sample string 6",
    "RegionLocalCode": "sample string 7",
    "Region": "sample string 8",
    "ICode": "sample string 9",
    "LocalityTypeName": "sample string 10",
    "KATO": "sample string 11"
  }
]

application/xml, text/xml

Пример: 
<ArrayOfLocalityAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <LocalityAPI>
    <Country>sample string 6</Country>
    <CountryLocalCode>sample string 5</CountryLocalCode>
    <ICode>sample string 9</ICode>
    <ILocalityName>sample string 4</ILocalityName>
    <KATO>sample string 11</KATO>
    <LocalCode>sample string 1</LocalCode>
    <LocalityName>sample string 2</LocalityName>
    <LocalityNameKaz>sample string 3</LocalityNameKaz>
    <LocalityTypeName>sample string 10</LocalityTypeName>
    <Region>sample string 8</Region>
    <RegionLocalCode>sample string 7</RegionLocalCode>
  </LocalityAPI>
  <LocalityAPI>
    <Country>sample string 6</Country>
    <CountryLocalCode>sample string 5</CountryLocalCode>
    <ICode>sample string 9</ICode>
    <ILocalityName>sample string 4</ILocalityName>
    <KATO>sample string 11</KATO>
    <LocalCode>sample string 1</LocalCode>
    <LocalityName>sample string 2</LocalityName>
    <LocalityNameKaz>sample string 3</LocalityNameKaz>
    <LocalityTypeName>sample string 10</LocalityTypeName>
    <Region>sample string 8</Region>
    <RegionLocalCode>sample string 7</RegionLocalCode>
  </LocalityAPI>
</ArrayOfLocalityAPI>