2 378 документов
← К списку

СведенияОбАдресе

страница

Возвращает сведения об адресе в виде отдельных частей адреса и различных кодов (код региона, ОКТМО и др.). Для преобразования полученных полей адреса в во внутренний формат JSON следует использовать функцию ПоляАдресаВJSON.

Синтаксис

Функция СведенияОбАдресе(Адрес, ДополнительныеПараметры = Неопределено) Экспорт

Параметры

  • Адрес — Строка - адрес во внутреннем формате JSON или в XML, соответствующем XDTO-пакету Адрес.
    • ОбъектXDTO - XDTO-объект, соответствующий XDTO пакету Адрес.
    • Неопределено - конструктор для получения пустых полей адреса.
  • ДополнительныеПараметры — Структура - для уточнения возвращаемого значения. Может содержать только поля, отличающиеся от значений по умолчанию:
    • БезПредставлений - Булево - если Истина, то поле Представление будет отсутствовать. По умолчанию Ложь.
    • КодыАдреса - Булево - если Истина, то результат содержит поля ИдентификаторАдресногоОбъекта, ИдентификаторДома и структура с кодами адреса(Идентификаторы, ДополнительныеКоды, КодыКЛАДР). Подробнее см. в возвращаемом значении структуры Идентификаторы и ДополнительныеКоды. По умолчанию, Ложь. Если в адресе отсутствуют идентификаторы и в программу не загружены идентификаторы адресных объектов адреса, то получение идентификаторов может инициировать http запрос к веб-сервису 1С orgaddress.
    • КодыКЛАДР - Булево - если Истина, то возвращается структура КодыКЛАДР. По умолчанию Ложь. Если в адресе отсутствуют коды и в программу не загружены адресные объекты адреса, Получение кодов может инициировать http запрос к веб-сервису 1С orgaddress.
    • НаименованиеВключаетСокращение - Булево - если Истина, то поля содержат сокращениям в наименованиях адресных объектов.
    • ПроверитьАдрес - Булево - если Истина, то адрес будет проверен на соответствие адресному классификатору. По умолчанию Ложь. Если в программу не загружены проверяемые адресные объекты, то проверка адреса может инициировать http запрос к веб-сервису 1С orgaddress.
    • ПолноеНаименованиеСокращений - Булево - устаревший параметр. Следует использовать свойства свойства возвращаемого значения с постфиксами ТипПолный и ТипКраткий. По умолчанию, Ложь.

Возвращаемое значение

Структура:

  • Представление - Строка - текстовое представление адреса по административно-территориальному делению.
  • МуниципальноеПредставление - Строка - текстовое представление адреса по муниципальному делению.
  • ТипАдреса - Строка - основной тип адреса (только для адресов РФ). Варианты: "Муниципальный", "Административно-территориальный".
  • Страна - Строка - текстовое представление страны.
  • КодСтраны - Строка - код страны по ОКСМ.
  • Индекс - Строка - почтовый индекс.
  • КодРегиона - Строка - код региона РФ.
  • Регион - Строка - текстовое представление региона РФ. Для получения полного наименования региона следует использовать функцию РегионАдресаКонтактнойИнформации.
  • РегионТипПолный - Строка - полное наименование типа региона. Например: "область".
  • РегионТипКраткий - Строка - краткое наименование типа региона. Например: "обл".
  • РегионСокращение - Строка - устаревшее свойство. Сокращение региона, например: "обл", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "область", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА.
  • Округ - Строка - устаревшее свойство. Текстовое представление округа.
  • ОкругСокращение - Строка - устаревшее свойство. Сокращение округа.
  • Район - Строка - текстовое представление района у адресов по административно-территориальному делению.
  • РайонТипПолный - Строка - полное наименование типа района для адреса по административно-территориальному делению. Например: "район".
  • РайонТипКраткий - Строка - краткое наименование типа района для адреса по административно-территориальному делению. Например: "р-н".
  • РайонСокращение - Строка - устаревшее свойство. Сокращение района для адреса по административно-территориальному делению, например: "р-н", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "район", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА.
  • МуниципальныйРайон - Строка - текстовое представление муниципального района для адреса по муниципальному делению.
  • МуниципальныйРайонТипПолный - Строка - полное наименование типа муниципального района по муниципальному делению. Например: "городской округ".
  • МуниципальныйРайонТипКраткий - Строка - краткое наименование типа муниципального района для адреса по муниципальному делению. Например: "мун.р-н".
  • МуниципальныйРайонСокращение - Строка - устаревшее свойство. Сокращение муниципального района для адреса по муниципальному делению, например: "мун.р-н", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "муниципальный район", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА.
  • КодМуниципальногоРайона - Строка - код муниципального района: 1- муниципальный район; 2- городской округ; 3 - внутригородская территория города федерального значения; 4 - муниципальный округ; 5 - федеральная территория. Если не удалось определить код, то возвращается пустая строка.
  • Город - Строка - текстовое представление города у адресов по административно-территориальному делению.
  • ГородТипПолный - Строка - полное наименование типа города у адресов по административно-территориальному делению.
  • ГородТипКраткий - Строка - текстовое представление города у адресов по административно-территориальному делению.
  • ГородСокращение - Строка - сокращение города у адресов по административно-территориальному делению.
  • Поселение - Строка - текстовое представление поселения у адресов по муниципальному делению.
  • ПоселениеТипПолный - Строка - полное наименование типа сельского поселения по муниципальному делению. Например: "сельское поселение".
  • ПоселениеТипКраткий - Строка - краткое наименование типа муниципального района для адреса по муниципальному делению. Например: "с. п.".
  • ПоселениеСокращение - Строка - устаревшее свойство. Сокращение сельского поселения для адреса по муниципальному делению, например: "с. п.", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "сельское поселение", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА
  • КодПоселения - Строка - код поселения: 1 - городское поселение; 2 - сельское поселение; 3- межселенная территория в составе муниципального района; 4 - внутригородской район городского округа;
  • ВнутригородскойРайон - Строка - текстовое представление внутригородского района.
  • ВнутригородскойРайонТипПолный - Строка - полное наименование типа внутригородского района. Например: "микрорайон".
  • ВнутригородскойРайонТипКраткий - Строка - краткое наименование типа внутригородского района. Например: "мкр".
  • ВнутригородскойРайонСокращение - Строка - устаревшее свойство. Сокращение внутригородского района, например: "мкр", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "микрорайон", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА
  • НаселенныйПункт - Строка - текстовое представление населенного пункта.
  • НаселенныйПунктТипПолный - Строка - полное наименование типа населенного пункта. Например: "деревня".
  • НаселенныйПунктТипКраткий - Строка - краткое наименование типа населенного пункта. Например: "д".
  • НаселенныйПунктСокращение - Строка - устаревшее свойство. Сокращение населенного пункта, например: "д", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "деревня", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА
  • Территория - Строка - текстовое представление территории.
  • ТерриторияТипПолный - Строка - полное наименование типа территории. Например: "Гаражно-строительный кооп.".
  • ТерриторияТипКраткий - Строка - краткое наименование типа территории. Например: "гск".
  • ТерриторияСокращение - Строка - устаревшее свойство. Сокращение населенного пункта, например: "гск", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "Гаражно-строительный кооп.", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА
  • Улица - Строка - текстовое представление улицы.
  • УлицаТипПолный - Строка - полное наименование типа улицы. Например: "Улица".
  • УлицаТипКраткий - Строка - краткое наименование типа улицы. Например: "ул".
  • УлицаСокращение - Строка - устаревшее свойство. Сокращение улицы, например: "гск", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ЛОЖЬ, или "Улица", если ДополнительныеПараметры.ПолноеНаименованиеСокращений = ИСТИНА
  • ДополнительнаяТерритория - Строка - устаревшее свойство. Текстовое представление дополнительной территории.
  • ДополнительнаяТерриторияСокращение - Строка - устаревшее свойство. Сокращение дополнительной территории.
  • ЭлементДополнительнойТерритории - Строка - устаревшее свойство. Текстовое представление элемента дополнительной территории.
  • ЭлементДополнительнойТерриторииСокращение - Строка - устаревшее свойство. Сокращение элемента дополнительной территории.
  • Здание - Структура - структура с информацией о здании адреса: ** ТипЗдания - Строка - тип объекта адресации адреса РФ согласно приказу Минфина России от 5.11.2015 г. N171н. ** Номер - Строка - текстовое представление номера дома (только для адресов РФ).
  • Корпуса - Массив - содержит структуры (поля структуры: ТипКорпуса, Номер) с перечнем корпусов адреса.
  • Помещения - Массив - содержит структуры (поля структуры: ТипПомещения, Номер) с перечнем помещений адреса.
  • НомерЗемельногоУчастка - Строка - текстовое представление номера земельного участка (только для адресов РФ).
  • Комментарий - Строка - комментарий об адресе.
  • ИдентификаторАдресногоОбъекта - УникальныйИдентификатор - идентификационный код последнего адресного объекта в иерархи адреса. Например, для адреса: Москва г., Дмитровское ш., д.9 это будет идентификатор улицы. Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь.
  • ИдентификаторДома - УникальныйИдентификатор - идентификационный код дома(строения) адресного объекта. Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь. Пустая строка если значение отсутствует.
  • ИдентификаторЗемельногоУчастка - УникальныйИдентификатор - идентификационный код земельного участка адресного объекта. При отсутствии значения - пустая строка.
  • Идентификаторы - Структура - где: Идентификаторы адресных объектов адреса, если установлен параметр КодыАдреса или КодыКЛАДР. Поле отсутствует, если дополнительный параметр КодыАдреса или КодыКЛАДР равен Ложь: ** Регион - УникальныйИдентификатор - идентификатор региона. ** Район - УникальныйИдентификатор - идентификатор района. ** МуниципальныйРайон - УникальныйИдентификатор - идентификатор муниципального района. ** Город - УникальныйИдентификатор - идентификатор города. ** Поселение - УникальныйИдентификатор - идентификатор поселения. ** ВнутригородскойРайон - УникальныйИдентификатор - идентификатор внутригородского района. ** НаселенныйПункт - УникальныйИдентификатор - идентификатор населенного пункта. ** Территория - УникальныйИдентификатор - идентификатор территории. ** Улица - УникальныйИдентификатор - идентификатор улица.
  • КодыКЛАДР - Структура - коды КЛАДР, если параметр КодыКЛАДР установлен в Истина. Где: ** Регион - Строка - код КЛАДР региона. ** Район - Строка - код КЛАДР район. ** Город - Строка - код КЛАДР города. ** НаселенныйПункт - Строка - код КЛАДР населенного пункта. ** Улица - Строка - код КЛАДР улицу.
  • ДополнительныеКоды - Структура - коды ОКТМО, ОКТМОБюджетополучателя, ОКАТО, КодИФНСФЛ, КодИФНСЮЛ, КодУчасткаИФНСФЛ, КодУчасткаИФНСЮЛ. Поле отсутствует, если дополнительный параметр КодыАдреса равен Ложь.
  • РезультатПроверкиАдреса - Строка - "Успех", если адрес корректный, "Ошибка" - при наличии ошибок проверки, "Отказ", если не удалось проверить адрес, т.к. недоступен классификатор. Пустая строка, если в параметре ДополнительныеПараметры.ПроверитьАдрес не установлен флаг ПроверитьАдрес.
  • ОшибкиПроверкиАдреса - Строка - описание ошибок в адресе, выявленных в ходе проверки.

Пример вызова

Результат = РаботаСАдресами.СведенияОбАдресе(Адрес, ДополнительныеПараметры)

Доступность

Сервер, Толстый клиент, Внешнее соединение