Exportcenter:GetLegalEntityList:v2.0
Версия от 04:08, 8 сентября 2021; Romanov-av-170814 (обсуждение | вклад)
Общие сведения
Операция 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] | Максимальное запрашиваемое количество объектов в списке.
|
004 | ······<bs:offset>2</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
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 | [1..1] | Юридический адрес.
|
014 | ·········<dt:country> | dt:Country | [1..1] | Страна. |
015 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор страны.
|
016 | ············<dt:code>RU</dt:code> | dt:Code | [1..1] | Код страны.
|
017 | ·········</dt:country> | |||
018 | ·········<dt:region> | dt:Region | [1..1] | Регион (республика, область, край, автономная область). |
019 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор региона страны.
|
020 | ·········</dt:region> | |||
021 | ·········<dt:district> | dt:District | [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 | Заданный в запросе отступ больше числа записей в результате запроса. |