Geocode - Получение геокоординат по заданному почтовому адресу

Общая информация

  1. Команда актуальна, начиная с версии 1.18

  2. Команда используется для подстановки полученных геокоординат в команду CreateRuleLink

Входные параметры

Параметр Значение Формат значения Расшифровка формата

parameters

Почтовый адрес в формате КЛАДР

Массив объектов NbiParameter

Параметры адреса в формате КЛАДР и их допустимые значения

Выходные параметры

Параметр Значение Формат значения

code

Код ответа

Целое неотрицательное число

detail

Пояснение к ответу

Текст английскими буквами с пробелами и спецсимволами

coordinates

Массив объектов GeoCoordinateItem

match

Флаг однозначно определенных геокоординат

true/false

Параметры адреса в формате КЛАДР и их допустимые значения

Параметр Значение Формат значения Расшифровка формата Обязательный параметр

Country

Страна

^[ \-a-zA-Zа-яА-ЯёЁ]{1,64}$

Текст до 64-х символов

Нет

Region

Область

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,64}$

Текст до 64-х символов

Нет

District

Район

^[ \-a-zA-Zа-яА-ЯёЁ0-9]{0,64}$

Текст до 64-х символов

Нет

City

Город

^[ .\-a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст до 64-х символов

Да

Street

Улица

^[ .\-/a-zA-Zа-яА-ЯёЁ0-9]{1,64}$

Текст до 64-х символов

Да

HouseNumber

Номер дома

^[ _.\-/a-zA-Zа-яА-ЯёЁ0-9]{1,35}$

Текст до 35-и символов

Да

Примеры команд и кодов

Код Описание ошибки

0

Успешно

3

Ошибка ответа от EMS NBI

45

Неизвестный ответ от EMS сервера

312

Некорректное значение для параметра

313

Неизвестное название параметра

436

Не указан обязательный параметр
Запрос
    <nbi:geocode>
        <nbi:parameters>
            <xsd:parameter>
                <xsd:name>Region</xsd:name>
                <xsd:value>Новосибирская</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
                <xsd:name>City</xsd:name>
                <xsd:value>Новосибирск</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
                <xsd:name>Street</xsd:name>
                <xsd:value>Окружная</xsd:value>
            </xsd:parameter>
            <xsd:parameter>
                <xsd:name>HouseNumber</xsd:name>
                <xsd:value>13</xsd:value>
            </xsd:parameter>
        </nbi:parameters>
    </nbi:geocode>
Ответ
    <ns:geocode>
       <ns:return>
          <ax21:code>0</ax21:code>
          <ax21:detail/>
          <ax292:coordinates xsi:type="ax292:GeoCoordinateItem">
             <ax292:address>Новосибирская обл, Новосибирск г, Окружная ул, д 13</ax292:address>
             <ax292:latitude>55.0859138</ax292:latitude>
             <ax292:longitude>82.9357454</ax292:longitude>
          </ax292:coordinates>
          <ax292:match>true</ax292:match>
       </ns:return>
    </ns:geocode>

Вернуться к списку команд
Версия 1.21-2362
Дата публикации 17-01-2022 09:09:34