GET
/api/v1/post-code
Почтовый индекс
Почтовый индекс
Параметры
Параметр |
Тип |
Обязательно |
Описание |
apiKey |
string |
true |
Апи-ключ |
locale |
|
true |
Настройки локализации ответного сообщения |
locale[lang] |
string |
true |
ISO код языка на котором будет сформирован ответ (ISO 639-1) |
locale[fallbackLang] |
string |
false |
ISO код резервного языка на котором будет сформирован ответ (ISO 639-1) (используется когда отсутствует название объекта на основном языке) |
filter |
|
false |
Фильтр |
filter[cityId] |
integer |
false |
Идентификатор города |
filter[streetId] |
integer |
false |
Идентификатор улицы |
filter[houseNumber] |
string |
false |
Номер дома |
filter[housingNumber] |
string |
false |
Корпус |
filter[structureNumber] |
string |
false |
Строение |
Ответ
200
Параметр |
Тип |
Обязательно |
Описание |
success |
boolean |
false |
Флаг успешного запроса |
language |
string |
false |
Язык ответа |
result |
string |
false |
Результат запроса |
error |
object |
false |
Информация об ошибках при выполнении запроса |
POST
/api/v1/phone-collection-data
Получение часового пояса по массиву телефонов
Получение часового пояса по массиву телефонов
Параметры
Параметр |
Тип |
Обязательно |
Описание |
apiKey |
string |
true |
Апи-ключ |
locale |
|
true |
Настройки локализации ответного сообщения |
locale[lang] |
string |
true |
ISO код языка на котором будет сформирован ответ (ISO 639-1) |
locale[fallbackLang] |
string |
false |
ISO код резервного языка на котором будет сформирован ответ (ISO 639-1) (используется когда отсутствует название объекта на основном языке) |
filter |
|
false |
Фильтр |
filter[phones][] |
array |
false |
Телефоны |
Ответ
200
Параметр |
Тип |
Обязательно |
Описание |
success |
boolean |
false |
Флаг успешного запроса |
language |
string |
false |
Язык ответа |
result[] |
array |
false |
Результат запроса |
result[][id] |
integer |
false |
Автоинкрементальный идентификатор |
result[][dataSource] |
string |
false |
Источник данных |
result[][abcDefCode] |
integer |
false |
ABC/DEF код |
result[][rangeStart] |
integer |
false |
Начало диапазона |
result[][rangeEnd] |
integer |
false |
Конец диапазона |
result[][providerName] |
string |
false |
Имя оператора |
result[][region] |
|
false |
Регион |
result[][region][timezoneOffset] |
integer |
false |
Смещение времени относительно UTC в секундах |
result[][region][countryIso] |
string |
false |
ISO код (ISO 3166-1 alpha-2) |
result[][region][id] |
integer |
false |
Автоинкрементальный идентификатор |
result[][region][name] |
string |
false |
Имя региона |
result[][region][codes] |
object |
false |
Словарь кодов региона - [codeName: code] |
result[][region][localityType] |
|
false |
Тип объекта |
result[][region][localityType][code] |
string |
false |
Код |
result[][region][localityType][name] |
string |
false |
Имя типа |
result[][region][localityType][localizedNamesShort] |
object |
false |
Словарь коротких локализованных имен - [languageIsoCode: localizedName] |
result[][region][localityType][localizedNames] |
object |
false |
Словарь локализованных имен - [languageIsoCode: localizedName] |
result[][region][timezone] |
string |
false |
Часовой пояс региона (Пример: "Europe/London") |
result[][region][countryId] |
integer |
false |
Страна |
result[][region][externalIds] |
object |
false |
Словарь идентификаторов в системах, откуда получены данные - [code: id] |
result[][region][localizedNames] |
object |
false |
Словарь локализованных имен - [languageIsoCode: localizedName] |
result[][country] |
|
false |
Страна |
result[][country][id] |
integer |
false |
Автоинкрементальный идентификатор |
result[][country][name] |
string |
false |
Имя страны |
result[][country][iso] |
string |
false |
ISO код (ISO 3166-1 alpha-2) |
result[][country][iso3] |
string |
false |
ISO3 код (ISO 3166-1 alpha-3) |
result[][country][isoNumeric] |
string |
false |
isoNumeric код (ISO 3166-1 numeric) |
result[][country][fips] |
string |
false |
fips код |
result[][country][continent] |
string |
false |
Континет |
result[][country][currencyCode] |
string |
false |
Валюта |
result[][country][phonePrefix] |
object |
false |
Телефон |
result[][country][postalCodeFormat] |
string |
false |
Формат почтового индекса |
result[][country][postalCodeRegex] |
string |
false |
Regex |
result[][country][languages] |
object |
false |
Массив языков, используемых в стране (ISO 639-1 коды языков) |
result[][country][timezoneOffset] |
integer |
false |
Смещение времени относительно UTC в секундах (если для все страны одно смещение) |
result[][country][externalIds] |
object |
false |
Словарь идентификаторов в системах, откуда получены данные - [code: id] |
result[][country][localizedNames] |
object |
false |
Словарь локализованных имен - [languageIsoCode: localizedName] |
result[][phoneParts] |
object |
false |
Телефон, разбитый на части (countryCode - код страны, code - код города, региона, мобильного оператора, number - номер телефона без кодов) |
error |
object |
false |
Информация об ошибках при выполнении запроса |