Exportcenter:GetLegalEntityChangesList:v2.0

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

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

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

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

Пространство имён (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:getLegalEntityChangesList>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка.
003 ······<bs:count>10</bs:count> xs:nonNegativeInteger [0..1]

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

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

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

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<bs:updateDateInterval> bs:DataInterval [1..1]

Интервал времени обновления.

  • В список попадают все записи, дата обновлений которых попадает в указанный интервал.
007 ······<bs:beginDate>2017-07-07T00:00:00</bs:beginDate> xs:dateTime [1..1] Начало временного интервала.
008 ······<bs:endDate>2017-07-25T00:00:00</bs:endDate> xs:dateTime [0..1]

Конец временного интервала.

  • Текущий день, если не указано.
009 ···</bs:updateDateInterval>
010 </ws:getLegalEntityChangesList>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getLegalEntityChangesList>
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 ·········<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<dt:type>?</dt:type> dt:BusinessEntityType [1..1]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Код страны

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

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

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