Exportcenter:GetLegalEntityList:v2.0

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

Общие сведения

Операция GetLegalEntityList предназначена для получения списка хозяйствующих субъектов. В список попадают только актуальные записи (active = true). Поддерживается возможность постраничного вывода и фильтрации по шаблону.

Используемые пространства имён

Пространство имён (xmlns) XSD-схема, содержащая описание типов
xmlns:bs="http://api.vetrf.ru/schema/cdm/base" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/base_v2.0.xsd
xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/registry_ws_definitions_v2.2.xsd
xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/dictionary_v2.2.xsd

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getLegalEntityListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
003 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке.

  • По умолчанию значение 100;
  • Максимально возможное значение 1000.
004 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка.

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте.
007 ······<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии хозяйствующего субъекта.
008 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта.
009 ······<dt:name>?</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта.

  • Указывается только для юридических лиц.
010 ······<dt:fio>?</dt:fio> bs:String255 [0..1]

ФИО индивидуального предпринимателя.

  • Для юридических лиц поле не указывается.
011 ······<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта.
012 ······<dt:ogrn>?</dt:ogrn> bs:String255 [0..1]

ОГРН или ОГРНИП.

  • Для ИП ОГРНИП может быть не указано.
013 ······<dt:juridicalAddress> dt:Address [0..1] Юридический адрес.
014 ·········<dt:country> dt:Country [0..1] Страна.
015 ············<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор страны.
016 ············<dt:code>?</dt:code> dt:Code [0..1]

Код страны.

  • двухбуквенный код страны, соответствующий стандарту ISO 3166-1
017 ·········</dt:country>
018 ·········<dt:region> dt:Region [0..1] Регион (республика, область, край, автономная область).
019 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона страны.
020 ·········</dt:region>
021 ·········<dt:district> dt:District [0..1] Район региона.
022 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона.
023 ·········</dt:district>
024 ·········<dt:locality> dt:Locality [0..1] Населённый пункт.
025 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор города региона (города регионального подчинения) страны.
026 ·········</dt:locality>
027 ······</dt:juridicalAddress>
028 ···</dt:businessEntity>
029 </ws:getLegalEntityListRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getLegalEntityListRequest>
002 ···<dt:businessEntityList total="?" offset="?" count="?"> dt:BusinessEntityList [1..1]

Список хозяйствующих субъектов.

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:businessEntity> dt:BusinessEntity [0..*] Сведения о хозяйствующем субъекте
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Флаг, указывающий на то, активна ли запись

  • true - запись активна;
  • false - запись не активна.
007 ·········<bs:last>?</bs:last> xs:boolean [1..1]

Флаг, указывающий на то, является ли запись последней

  • true - да;
  • false - нет.
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус версии записи
009 ·········<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания версии записи
010 ·········<bs:updateDate>?</bs:createDate> xs:DateTime [1..1] Дата последнего обновления версии записи
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
012 ·········<dt:type>?</dt:type> dt:BusinessEntityType [1..1]

Тип создаваемого или редактируемого хозяйствующего субъекта

  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
013 ·········<dt:name>?</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта

  • Возвращается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается.
014 ·········<dt:incorporationForm> dt:IncorporationForm [0..1] Организационно-правовая форма хозяйствующего субъекта
015 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии организационно-правовой формы.
016 ············<dt:name>?</dt:name> bs:String255 [1..1]

Название организационно-правовой формы предприятия.

  • согласно справочнику ОКОПФ.
017 ············<dt:code>?</dt:code> bs:String255 [1..1]

Код организационно-правовой формы предприятия.

  • согласно справочнику ОКОПФ.
018 ············<dt:shortName>?</dt:shortName> bs:String255 [0..1] Краткое название организационно-правовой формы предприятия.
019 ·········</dt:incorporationForm>
020 ·········<dt:fullName>?</dt:fullName> bs:String255 [0..1]

Полное наименование хозяйствующего субъекта

  • с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
021 ·········<dt:fio>?</dt:fio> bs:String255 [0..1]

ФИО физического лица или индивидуального предпринимателя

  • для юридических лиц поле не возвращается.
022 ·········<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта
023 ·········<dt:kpp>?</dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП)
024 ·········<dt:ogrn>?</dt:ogrn> bs:String255 [0..1]

ОГРН или ОГРНИП

  • Для ИП ОГРНИП может быть не указано.
025 ·········<dt:juridicalAddress> dt:Address [1..1]

Юридический адрес

  • адрес, по которому зарегистрирован хозяйствующий субъект.
026 ············<dt:country> dt:Country [1..1] Сведения о стране
027 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
028 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
029 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
030 ···············<dt:code>?</dt:code> dt:Code [1..1]

Код страны

  • ОКСМ, alpha-2
031 ············</dt:country>
032 ············<dt:region> dt:Region [1..1] Сведения о регионе
033 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
034 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
035 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона
036 ············</dt:region>
037 ············<dt:district> dt:District [0..1] Сведения о районе региона
038 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
039 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
040 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района региона
041 ············</dt:district>
042 ············<dt:locality> dt:Locality [0..1] Сведения о населенном пункте
043 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
044 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
045 ···············<dt:name>?</dt:name> bs:String255 [1..1]
046 ············</dt:locality>
047 ············<dt:sublocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
048 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
049 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
050 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
051 ············</dt:sublocality>
052 ············<dt:street> dt:Street [0..1] Сведения об улице
053 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор версии записи
054 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
055 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование улицы
056 ············</dt:street>
057 ············<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
058 ············<dt:bulding>?</dt:bulding> bs:String255 [0..1] Номер строения
059 ············<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
060 ············<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
061 ············<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
062 ············<dt:additionalInfo>?</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация
063 ············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
064 ·········</dt:juridicalAddress>
065 ······</dt:businessEntity>
066 ···</dt:businessEntityList>
067 </ws:getLegalEntityListRequest>

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

Ошибка Описание
InternalServiceFault Внутренняя ошибка сервиса.
IncorrectRequestFault Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd, то есть сообщение не проходит валидацию.
OffsetOutOfRangeFault Заданный в запросе отступ больше числа записей в результате запроса.
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:GetLegalEntityList:v2.0&oldid=32745