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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 353: Строка 353:
|009
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|xs:DateTime
|xs:dateTime
|[1..1]
|[1..1]
| style="width:52em;"| Дата создания записи
| style="width:52em;"| Дата создания записи
Строка 359: Строка 359:
|010
|010
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|xs:DateTime
|xs:dateTime
|[1..1]
|[1..1]
| style="width:52em;"| Дата последнего изменения записи
| style="width:52em;"| Дата последнего изменения записи

Версия 03:00, 16 февраля 2024

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityListRequest>
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:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
011 ······<dt:fio>?</dt:fio> bs:String255 [0..1]

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

  • Для юридических лиц поле не указывается
012 ······<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта
013 ······<dt:kpp>?</dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП)
014 ······<dt:ogrn>?</dt:ogrn> bs:String255 [0..1] ОГРН или ОГРНИП
015 ······<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
016 ·········<dt:country> dt:Country [0..1] Страна
017 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
018 ·········</dt:country>
019 ·········<dt:region> dt:Region [0..1] Регион
020 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
021 ·········</dt:region>
022 ·········<dt:district> dt:District [0..1] Район
023 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
024 ·········</dt:district>
025 ·········<dt:locality> dt:Locality [0..1] Город
026 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
027 ·········</dt:locality>
028 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт
029 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
030 ·········</dt:subLocality>
031 ·········<dt:street> dt:Street [0..1] Улица
032 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
033 ·········</dt:street>
034 ·········<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
035 ·········<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
036 ·········<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
037 ·········<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
038 ······</dt:juridicalAddress>
039 ···</dt:businessEntity>
040 </ws:getBusinessEntityListRequest>

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

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

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

TODO

См. также

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

Источник — http://help.vetrf.ru/index.php?title=Herriot:GetBusinessEntityList:v1.0&oldid=39196