GetAddressesListByKladr - Получение списка адресов по КЛАДР по городу, улице и номеру дома.
Общая информация
-
Команда актуальна, начиная с версии 1.18.
-
Команда позволяет получить список адресов по КЛАДР, который отображается в виде структуры дерева: область, регион, город, улица, номер дома, каждый элемент которого содержит атрибуты id, name, okato, type, typeShort, zip. Параметры город, улица и номер дома являются обязательными.
-
Параметр match определяет точное совпадение искомого адреса в найденном списке адресов по КЛАДР и равен true, если такое совпадение уникально. Если адреса не найдены или найдено несколько адресов, то match равен false.
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата |
|---|---|---|---|
parameters |
Почтовый адрес в формате КЛАДР |
Массив объектов NbiParameter |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
match |
boolean |
|
response |
||
code |
Код ответа |
int |
detail |
Пояснение к ответу |
String |
Примеры команд и кодов
| Код | Описание |
|---|---|
0 |
Успешно |
Запрос
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:nbi="http://nbi.radius.eltex.org"
xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
<soap:Body>
<nbi:GetAddressesListByKladr>
<nbi:parameters>
<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>29В</xsd:value>
</xsd:parameter>
</nbi:parameters>
</nbi:GetAddressesListByKladr>
</soap:Body>
</soap:Envelope>Ответ
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<ns:GetAddressesListByKladrResponse xmlns:ns="http://nbi.radius.eltex.org">
<ns:return xsi:type="ax298:GetAddressesListResponse">
<ax21:code>0</ax21:code>
<ax21:detail></ax21:detail>
<ax298:match>true</ax298:match>
<ax298:response xsi:type="ax298:AddressResponse">
<ax298:addresses xsi:type="ax298:CommonKladrAddress">
<ax298:region xsi:type="ax298:Region">
<ax298:id>5400000000000</ax298:id>
<ax298:name>Новосибирская</ax298:name>
<ax298:okato>50000000000</ax298:okato>
<ax298:type>Область</ax298:type>
<ax298:typeShort>обл</ax298:typeShort>
<ax298:zip>630545</ax298:zip>
<ax298:district xsi:type="ax298:District">
<ax298:id xsi:nil="true" />
<ax298:name xsi:nil="true" />
<ax298:okato xsi:nil="true" />
<ax298:type xsi:nil="true" />
<ax298:typeShort xsi:nil="true" />
<ax298:zip xsi:nil="true" />
<ax298:city xsi:type="ax298:City">
<ax298:id>5400000100000</ax298:id>
<ax298:name>Новосибирск</ax298:name>
<ax298:okato>50401000000</ax298:okato>
<ax298:type>Город</ax298:type>
<ax298:typeShort>г</ax298:typeShort>
<ax298:zip>630132</ax298:zip>
<ax298:street xsi:type="ax298:Street">
<ax298:id>54000001000091600</ax298:id>
<ax298:name>Окружная</ax298:name>
<ax298:okato>50401373000</ax298:okato>
<ax298:type>Улица</ax298:type>
<ax298:typeShort>ул</ax298:typeShort>
<ax298:zip>630020</ax298:zip>
<ax298:house xsi:type="ax298:House">
<ax298:id>5400000100009160001</ax298:id>
<ax298:name>29В</ax298:name>
<ax298:okato>50401373000</ax298:okato>
<ax298:type>дом</ax298:type>
<ax298:typeShort>д</ax298:typeShort>
<ax298:zip>630020</ax298:zip>
</ax298:house>
</ax298:street>
</ax298:city>
</ax298:district>
</ax298:region>
</ax298:addresses>
</ax298:response>
</ns:return>
</ns:GetAddressesListByKladrResponse>
</soapenv:Body>
</soapenv:Envelope>| Код | Описание ошибки |
|---|---|
281 |
Параметр запроса не указан или пуст |
312 |
Некорректное значение для параметра |
313 |
Неизвестный параметр |
436 |
Не указан обязательный параметр |
Вернуться к списку команд
Версия 1.23-2695
Дата публикации 02-09-2022 11:42:18