Exportcenter:GetLegalEntityList:v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 21: | Строка 21: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | {| class="wikitable" | ||
! # | ! # | ||
| Строка 41: | Строка 42: | ||
|- | |- | ||
|003 | |003 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | ||
|[0..1] | |[0..1] | ||
| Строка 52: | Строка 53: | ||
|- | |- | ||
|004 | |004 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | ||
|[0..1] | |[0..1] | ||
| Строка 74: | Строка 75: | ||
|- | |- | ||
|007 | |007 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | ||
|[[UUID|bs:UUID]] | |[[UUID|bs:UUID]] | ||
|[0..1] | |[0..1] | ||
| Строка 80: | Строка 81: | ||
|- | |- | ||
|008 | |008 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | ||
|[[UUID|bs:UUID]] | |[[UUID|bs:UUID]] | ||
|[0..1] | |[0..1] | ||
| Строка 86: | Строка 87: | ||
|- | |- | ||
|009 | |009 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | ||
|[[String255|bs:String255]] | |[[String255|bs:String255]] | ||
|[0..1] | |[0..1] | ||
| Строка 96: | Строка 97: | ||
|- | |- | ||
|010 | |010 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}fio>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}fio>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fio>'''}} | ||
|[[String255|bs:String255]] | |[[String255|bs:String255]] | ||
|[0..1] | |[0..1] | ||
| Строка 106: | Строка 107: | ||
|- | |- | ||
|011 | |011 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}inn>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}inn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}inn>'''}} | ||
|[[String255|bs:String255]] | |[[String255|bs:String255]] | ||
|[0..1] | |[0..1] | ||
| Строка 112: | Строка 113: | ||
|- | |- | ||
|012 | |012 | ||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}ogrn>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}ogrn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}ogrn>'''}} | ||
|[[String255|bs:String255]] | |[[String255|bs:String255]] | ||
|[0..1] | |[0..1] | ||
| Строка 134: | Строка 135: | ||
|- | |- | ||
|015 | |015 | ||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | ||
|[[UUID|bs:UUID]] | |[[UUID|bs:UUID]] | ||
|[0..1] | |[0..1] | ||
| Строка 140: | Строка 141: | ||
|- | |- | ||
|016 | |016 | ||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}} | ||
|[[Code_v2.0|dt:Code]] | |[[Code_v2.0|dt:Code]] | ||
|[0..1] | |[0..1] | ||
| Строка 162: | Строка 163: | ||
|- | |- | ||
|019 | |019 | ||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | ||
|[[UUID|bs:UUID]] | |[[UUID|bs:UUID]] | ||
|[1..1] | |[1..1] | ||
| Строка 175: | Строка 176: | ||
|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]] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Район региона. | | style="width:52em;"| Район региона. | ||
|- | |- | ||
|022 | |022 | ||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313| | |style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | ||
|[[UUID|bs:UUID]] | |[[UUID|bs:UUID]] | ||
|[1..1] | |[1..1] | ||
Версия 04:13, 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>?</bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
| 004 | ······<bs:offset>?</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
| 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:fio>?</dt:fio> | bs:String255 | [0..1] | ФИО индивидуального предпринимателя.
|
| 011 | ······<dt:inn>?</dt:inn> | bs:String255 | [0..1] | ИНН хозяйствующего субъекта. |
| 012 | ······<dt:ogrn>?</dt:ogrn> | bs:String255 | [0..1] | ОГРН или ОГРНИП.
|
| 013 | ······<dt:juridicalAddress> | dt:Address | [0..1] | Юридический адрес. |
| 014 | ·········<dt:country> | dt:Country | [0..1] | Страна. |
| 015 | ············<bs:guid>?</bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор страны. |
| 016 | ············<dt:code>?</dt:code> | dt:Code | [0..1] | Код страны.
|
| 017 | ·········</dt:country> | |||
| 018 | ·········<dt:region> | dt:Region | [0..1] | Регион (республика, область, край, автономная область). |
| 019 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор региона страны. |
| 020 | ·········</dt:region> | |||
| 021 | ·········<dt:district> | dt:District | [0..1] | Район региона. |
| 022 | ············<bs: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 | Заданный в запросе отступ больше числа записей в результате запроса. |
