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

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


Получаем все населенные пункты указанной страны

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

URI параметры

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

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

string

Нет описания

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

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

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

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

string

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

Максимальная длина: 4

ApiKey

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

string

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

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

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

application/json, text/json

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

application/xml, text/xml

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

Примеры кода

$.ajax({
    type: 'POST',
    url: 'http://api.alemtat.kz/web/json/catalog/getCitiesByCountry',
    dataType: 'json',
    data: { ApiKey: 'Выданный API-ключ', CountryLocalCode: '0001' }
	success: function (data) {
        console.log(data);
    },
    error: function(xhr, status) {
        console.log(xhr.status + ': ' + xhr.statusText);
    }
});
$kv = array();
$kv['CountryLocalCode'] = '0001';
$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/getCitiesByCountry', false, $context);
echo $result;

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

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

Возвращает массив из населенных пунктов

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

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

string

Нет описания

LocalityName

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

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",
    "ILocalityName": "sample string 3",
    "CountryLocalCode": "sample string 4",
    "Country": "sample string 5",
    "RegionLocalCode": "sample string 6",
    "Region": "sample string 7",
    "ICode": "sample string 8",
    "LocalityTypeName": "sample string 9",
    "KATO": "sample string 10"
  },
  {
    "LocalCode": "sample string 1",
    "LocalityName": "sample string 2",
    "ILocalityName": "sample string 3",
    "CountryLocalCode": "sample string 4",
    "Country": "sample string 5",
    "RegionLocalCode": "sample string 6",
    "Region": "sample string 7",
    "ICode": "sample string 8",
    "LocalityTypeName": "sample string 9",
    "KATO": "sample string 10"
  }
]

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 5</Country>
    <CountryLocalCode>sample string 4</CountryLocalCode>
    <ICode>sample string 8</ICode>
    <ILocalityName>sample string 3</ILocalityName>
    <KATO>sample string 10</KATO>
    <LocalCode>sample string 1</LocalCode>
    <LocalityName>sample string 2</LocalityName>
    <LocalityTypeName>sample string 9</LocalityTypeName>
    <Region>sample string 7</Region>
    <RegionLocalCode>sample string 6</RegionLocalCode>
  </LocalityAPI>
  <LocalityAPI>
    <Country>sample string 5</Country>
    <CountryLocalCode>sample string 4</CountryLocalCode>
    <ICode>sample string 8</ICode>
    <ILocalityName>sample string 3</ILocalityName>
    <KATO>sample string 10</KATO>
    <LocalCode>sample string 1</LocalCode>
    <LocalityName>sample string 2</LocalityName>
    <LocalityTypeName>sample string 9</LocalityTypeName>
    <Region>sample string 7</Region>
    <RegionLocalCode>sample string 6</RegionLocalCode>
  </LocalityAPI>
</ArrayOfLocalityAPI>