Herriot:GetBusinessEntityChangesList:v1.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 1: Строка 1:
== Общие сведения ==
== Общие сведения ==
{| class="wikitable"
! Код !! Описание операции
|-
| '''ES.HRT.1.4'''
| Получение истории изменений справочника хозяйствующих субъектов за заданный интервал времени
|-
|}


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

Версия 01:47, 16 февраля 2024

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

Код Описание операции
ES.HRT.1.4 Получение истории изменений справочника хозяйствующих субъектов за заданный интервал времени

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityChangesListRequest>
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 ···<bs:updateDateInterval> bs:DateInterval [1..1] Интервал времени обновления
007 ······<bs:beginDate>?</bs:beginDate> xs:dateTime [1..1] Начало временного интервала
008 ······<bs:endDate>?</bs:endDate> xs:dateTime [0..1] Конец временного интервала
009 ···</bs:updateDateInterval>
010 </ws:getBusinessEntityChangesListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityChangesListResponse>
002 ···<dt:businessEntityList count="?" total="?" offset="?"> 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:updateDate> 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 [1..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:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
029 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
030 ············</dt:country>
031 ············<dt:region> dt:Region [1..1] Регион
032 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
033 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона
034 ············</dt:region>
035 ············<dt:district> dt:District [0..1] Район региона
036 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
037 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района
038 ············</dt:district>
039 ············<dt:locality> dt:Locality [0..1] Город
040 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
041 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование города
042 ············</dt:locality>
043 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт
044 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
045 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
046 ············</dt:subLocality>
047 ············<dt:street> dt:Street [0..1] Улица
048 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
049 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование улицы
050 ············</dt:street>
051 ············<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
052 ············<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
053 ············<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
054 ············<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
055 ············<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
056 ············<dt:additionalInfo>?</dt:additionalInfo> bs:NText [0..1] Дополнительная информация
057 ············<dt:addressView>?</dt:addressView> bs:NText [0..1] Строковое представление адреса
058 ·········</dt:juridicalAddress>
059 ······</dt:businessEntity>
060 ···</dt:businessEntityList>
061 </ws:getBusinessEntityChangesListResponse>

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API Herriot:Services:v1.0