Exportcenter:GetLegalEntityList:v2.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 45: Строка 45:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке.
<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке.</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 100;
* По умолчанию значение 100;
Строка 57: Строка 56:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.  
<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* По умолчанию значение 0.</div>
* По умолчанию значение 0.</div>
Строка 92: Строка 90:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Наименование хозяйствующего субъекта без указания организационно-правовой формы.  
<span style="white-space:nowrap; font-weight: normal;">Наименование хозяйствующего субъекта.</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Указывается только для юридических лиц.
* Указывается только для юридических лиц.</div>
* Для индивидуальных предпринимателей поле не указывается.</div>
</div>
</div>
|-
|-
Строка 104: Строка 100:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">ФИО индивидуального предпринимателя.
<span style="white-space:nowrap; font-weight: normal;">ФИО индивидуального предпринимателя.</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Для юридических лиц поле не указывается.</div>
* Для юридических лиц поле не указывается.</div>
Строка 121: Строка 116:
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">ОГРН или ОГРНИП.  
<span style="white-space:nowrap; font-weight: normal;">ОГРН или ОГРНИП.</span>
</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* Для ИП ОГРНИП может быть не указано.</div>
* Для ИП ОГРНИП может быть не указано.</div>
Строка 130: Строка 124:
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}juridicalAddress>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}juridicalAddress>'''}}
|[[Address_v2.0|dt:Address]]
|[[Address_v2.0|dt:Address]]
|[1..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
| style="width:52em;"| Юридический адрес.
<span style="white-space:nowrap; font-weight: normal;">Юридический адрес.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* адрес, по которому зарегистрирован хозяйствующий субъект.</div>
</div>
|-
|-
|014
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}}
|[[Country_v2.0|dt:Country]]
|[[Country_v2.0|dt:Country]]
|[1..1]
|[0..1]
| style="width:52em;"| Страна.
| style="width:52em;"| Страна.
|-
|-
Строка 147: Строка 137:
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[0..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
| style="width:52em;"| Глобальный идентификатор страны.
<span style="white-space:nowrap; font-weight: normal;">Глобальный идентификатор страны.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* в соответствии со справочником РСХН.</div>
</div>
|-
|-
|016
|016
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|RU}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|RU}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|[[Code_v2.0|dt:Code]]
|[[Code_v2.0|dt:Code]]
|[1..1]
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;"> Код страны.</span>
<span style="white-space:nowrap; font-weight: normal;">Код страны.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
<div class="mw-collapsible-content" style="font-weight: normal;">
* двухбуквенный код страны, соответствующий стандарту ISO 3166-1. В качестве кода используются буквы латинского алфавита.
* двухбуквенный код страны, соответствующий стандарту ISO 3166-1</div>
</div>
</div>
</div>
|-
|-
Строка 173: Строка 158:
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|[[Region_v2.0|dt:Region]]
|[[Region_v2.0|dt:Region]]
|[1..1]
|[0..1]
| style="width:52em;"| Регион (республика, область, край, автономная область).
| style="width:52em;"| Регион (республика, область, край, автономная область).
|-
|-
Строка 180: Строка 165:
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
| style="width:52em;"| Глобальный идентификатор региона страны.
<span style="white-space:nowrap; font-weight: normal;">Глобальный идентификатор региона страны.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* в соответствии со справочником РСХН.</div>
</div>
|-
|-
|020
|020
Строка 194: Строка 175:
|021
|021
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}district>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}district>'''}}
|[[District_v2.0|dt:District]]
|[[Locality_v2.0|dt:Locality]]
|[0..1]
|[0..1]
| style="width:52em;"| Район региона.
| style="width:52em;"| Район региона.
Строка 202: Строка 183:
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
| style="width:52em;"| Глобальный идентификатор района региона.
<span style="white-space:nowrap; font-weight: normal;">Глобальный идентификатор района региона.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* в соответствии со справочником РСХН.</div>
</div>
|-
|-
|023
|023
Строка 224: Строка 201:
|[[UUID|bs:UUID]]  
|[[UUID|bs:UUID]]  
|[1..1]
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
| style="width:52em;"| Глобальный идентификатор города региона (города регионального подчинения) страны.
<span style="white-space:nowrap; font-weight: normal;">Глобальный идентификатор города региона (города регионального подчинения) страны.</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* в соответствии со справочником РСХН.</div>
</div>
|-
|-
|026
|026

Версия 04:10, 8 сентября 2021

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

Операция 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>10</bs:count> xs:nonNegativeInteger [0..1]

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

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

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

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте.
007 ······<bs:uuid>UUID</bs:uuid> bs:UUID [0..1] Идентификатор версии хозяйствующего субъекта.
008 ······<bs:guid>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>3312200096</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта.
012 ······<dt:ogrn>4085022240002</dt:ogrn> bs:String255 [0..1]

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

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

Код страны.

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

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

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

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