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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «== Общие сведения == == Спецификация запроса == == Спецификация ответа == == Примеры запросов...»)
 
Строка 2: Строка 2:


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getBESupervisedObjectListRequest>'''}}
|
|
| 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]
| style="width:52em;"| Количество элементов на странице
|-
|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]
| style="width:52em;"| Смещение в списке относительно начала
|-
|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
|[1..1]
|<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>
<div class="mw-collapsible-content" style="font-weight: normal;">
* В запросе обязательно должен быть передан один из параметров: guid или inn</div>
</div>
|-
|007
|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;"| Глобальный идентификатор хозяйствующего субъекта
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}inn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}inn>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| ИНН Хозяйствующего субъекта
|-
|009
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}businessEntity>'''}}
|
|
| style="width:52em;"|
|-
|010
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}supervisedObject>'''}}
|dt:SupervisedObject
|[0..1]
| style="width:52em;"| Сведения о поднадзорном объекте (ПО)
|-
|011
|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;"| Глобальный идентификатор ПО
|-
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}enterprise>'''}}
|dt:Enterprise
|[0..1]
| style="width:52em;"| Сведения о месте осуществления деятельности (площадке)
|-
|013
|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;"| Глобальный идентификатор площадки
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}}
|dt:Address
|[0..1]
| style="width:52em;"| Сведения об адресе
|-
|015
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|dt:Region
|[1..1]
| style="width:52em;"| Регион местонахождения площадки
|-
|016
|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;"| Глобальный идентификатор региона
|-
|017
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}address>'''}}
|
|
| style="width:52em;"|
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}enterprise>'''}}
|
|
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}approvalNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}approvalNumber>'''}}
|bs:Identifier
|[0..1]
| style="width:52em;"| Регистрационный номер ПО в реестре
|-
|021
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}approvalName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}approvalName>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| Название ПО
|-
|022
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}supervisedObject>'''}}
|
|
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}lookupScope>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}lookupScope>'''}}
|dt:RegistryLookupScope
|[0..1]
|<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>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Список возможных значений:
** ALL - Все записи
** AVAILABLE - Актуальные записи (для реестра поднадзорных объектов соответствует множеству записей в статусах UNVERIFIED и VERIFIED)
** VALID - Проверенные записи, включенные в реестр  (для реестра поднадзорных объектов соответствует множеству записей в статусе VERIFIED)
** UNAVAILABLE - Неактуальные записи  (для реестра поднадзорных объектов соответствует множеству записей в статусах CANCELED)
* '''Параметр запроса является опциональным, значение по умолчанию - VALID'''</div>
</div>
|-
|024
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getBESupervisedObjectListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Версия 07:41, 31 января 2024

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBESupervisedObjectListRequest>
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 [1..1]

Сведения о хозяйствующем субъекте

  • В запросе обязательно должен быть передан один из параметров: guid или inn
007 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта
008 ······<bs:inn>?</bs:inn> bs:String255 [0..1] ИНН Хозяйствующего субъекта
009 ···</dt:businessEntity>
010 ···<dt:supervisedObject> dt:SupervisedObject [0..1] Сведения о поднадзорном объекте (ПО)
011 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор ПО
012 ······<dt:enterprise> dt:Enterprise [0..1] Сведения о месте осуществления деятельности (площадке)
013 ·········<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор площадки
014 ·········<dt:address> dt:Address [0..1] Сведения об адресе
015 ············<dt:region> dt:Region [1..1] Регион местонахождения площадки
016 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона
017 ············</dt:region>
018 ·········</dt:address>
019 ······</dt:enterprise>
020 ······<dt:approvalNumber>?</dt:approvalNumber> bs:Identifier [0..1] Регистрационный номер ПО в реестре
021 ······<dt:approvalName>?</dt:approvalName> bs:String255 [0..1] Название ПО
022 ···</dt:supervisedObject>
023 ···<dt:lookupScope>?</dt:lookupScope> dt:RegistryLookupScope [0..1]

Область поиска в реестре поднадзорных объектов

  • Список возможных значений:
    • ALL - Все записи
    • AVAILABLE - Актуальные записи (для реестра поднадзорных объектов соответствует множеству записей в статусах UNVERIFIED и VERIFIED)
    • VALID - Проверенные записи, включенные в реестр (для реестра поднадзорных объектов соответствует множеству записей в статусе VERIFIED)
    • UNAVAILABLE - Неактуальные записи (для реестра поднадзорных объектов соответствует множеству записей в статусах CANCELED)
  • Параметр запроса является опциональным, значение по умолчанию - VALID
024 </ws:getBESupervisedObjectListRequest>

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

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

TODO

См. также

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

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