Herriot:GetBusinessEntityList:v1.0: различия между версиями
Перейти к навигации
Перейти к поиску
(Новая страница: «== Общие сведения == == Спецификация запроса == == Спецификация ответа == == Примеры запросов...») |
|||
| Строка 2: | Строка 2: | ||
== Спецификация запроса == | == Спецификация запроса == | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getBusinessEntityListRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}} | |||
|bs:ListOptions | |||
|[0..1] | |||
| style="width:52em;"| Параметры запрашиваемого списка | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}} | |||
|xs:nonNegativeInteger | |||
|[0..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* По умолчанию значение 100; | |||
* Максимально возможное значение 1000</div> | |||
</div> | |||
|- | |||
|004 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}} | |||
|xs:nonNegativeInteger | |||
|[0..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* По умолчанию значение 0.</div> | |||
</div> | |||
|- | |||
|005 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|006 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}businessEntity>'''}} | |||
|dt:BusinessEntity | |||
|[0..1] | |||
| style="width:52em;"| Данные о хозяйствующем субъекте | |||
|- | |||
|007 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | |||
|bs:UUID | |||
|[0..1] | |||
| style="width:52em;"| Идентификатор версии записи | |||
|- | |||
|008 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[0..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|009 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">Наименование хозяйствующего субъекта</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* Указывается только для юридических лиц | |||
* Для физических лиц и для индивидуальных предпринимателей поле не указывается</div> | |||
</div> | |||
|- | |||
|010 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fullName>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| Полное наименование хозяйствующего субъекта | |||
|- | |||
|011 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}fio>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fio>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " data-collapsetext="свернуть" style="font-weight: bold; width:52em;"> | |||
<span style="white-space:nowrap; font-weight: normal;">ФИО физического лица или индивидуального предпринимателя</span> | |||
<div class="mw-collapsible-content" style="font-weight: normal;"> | |||
* Для юридических лиц поле не указывается</div> | |||
</div> | |||
|- | |||
|012 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}inn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}inn>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| ИНН хозяйствующего субъекта | |||
|- | |||
|013 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}kpp>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}kpp>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| Код причины постановки на учет (КПП) | |||
|- | |||
|014 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}ogrn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}ogrn>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| ОГРН или ОГРНИП | |||
|- | |||
|015 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}juridicalAddress>'''}} | |||
|dt:Address | |||
|[1..1] | |||
| style="width:52em;"| Юридический адрес | |||
|- | |||
|016 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}} | |||
|dt:Country | |||
|[1..1] | |||
| style="width:52em;"| Страна | |||
|- | |||
|017 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|018 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}country>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|019 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}} | |||
|dt:Region | |||
|[1..1] | |||
| style="width:52em;"| Регион | |||
|- | |||
|020 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|021 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|022 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}district>'''}} | |||
|dt:District | |||
|[0..1] | |||
| style="width:52em;"| Район | |||
|- | |||
|023 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|024 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}district>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|025 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}locality>'''}} | |||
|dt:Locality | |||
|[0..1] | |||
| style="width:52em;"| Город | |||
|- | |||
|026 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|027 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}locality>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|028 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}subLocality>'''}} | |||
|dt:Locality | |||
|[0..1] | |||
| style="width:52em;"| Населённый пункт | |||
|- | |||
|029 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|030 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}subLocality>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|031 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}street>'''}} | |||
|dt:Street | |||
|[0..1] | |||
| style="width:52em;"| Улица | |||
|- | |||
|032 | |||
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|bs:UUID | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор записи | |||
|- | |||
|033 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}street>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|034 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}house>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}house>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| Номер дома | |||
|- | |||
|035 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}building>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}building>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| Номер строения | |||
|- | |||
|036 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}room>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}room>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| Номер квартиры / офиса | |||
|- | |||
|037 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}postIndex>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}postIndex>'''}} | |||
|bs:String255 | |||
|[0..1] | |||
| style="width:52em;"| Почтовый индекс | |||
|- | |||
|038 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}juridicalAddress>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|039 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}businessEntity>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|040 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getBusinessEntityListRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} | |||
== Спецификация ответа == | == Спецификация ответа == | ||
Версия 01:45, 16 февраля 2024
Общие сведения
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getBusinessEntityListRequest> | |||
| 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: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 | [1..1] | Юридический адрес |
| 016 | ·········<dt:country> | dt:Country | [1..1] | Страна |
| 017 | ············<bs:guid>?</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор записи |
| 018 | ·········</dt:country> | |||
| 019 | ·········<dt:region> | dt:Region | [1..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> |
Спецификация ответа
Примеры запросов
TODO
См. также
Вернуться к началу ↑
Вернуться на страницу профиля API Herriot:Services:v1.0
