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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «== Общие сведения == == Спецификация запроса == == Спецификация ответа == == Примеры запросов...»)
 
 
(не показаны 4 промежуточные версии 1 участника)
Строка 1: Строка 1:
== Общие сведения ==
== Общие сведения ==
{| class="wikitable"
! Код !! Описание операции
|-
| '''ES.HRT.3.3'''
| Получение списка площадок, зарегистрированных на территории РФ, с возможностью фильтрации
|-
|}


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getRussianEnterpriseListRequest>'''}}
|
|
| 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="&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;">
* По умолчанию значение 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="&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;">
* По умолчанию значение 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:}}enterprise>'''}}
|dt:Enterprise
|[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]
| style="width:52em;"| Полное наименование площадки
|-
|010
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}numberList>'''}}
|dt:EnterpriseNumberList
|[0..1]
| style="width:52em;"| Список номеров площадок
|-
|011
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}enterpriseNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}enterpriseNumber>'''}}
|bs:String255
|[1..*]
| style="width:52em;"| Номер площадки
|-
|012
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}numberList>'''}}
|
|
| style="width:52em;"|
|-
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}}
|dt:Address
|[0..1]
| style="width:52em;"| Фактический адрес расположения площадки
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}}
|dt:Country
|[0..1]
| style="width:52em;"| Страна
|-
|015
|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;"| Глобальный идентификатор записи
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}country>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|dt:Region
|[0..1]
| style="width:52em;"| Регион
|-
|018
|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;"| Глобальный идентификатор записи
|-
|019
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|
|
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}district>'''}}
|dt:District
|[0..1]
| style="width:52em;"| Район
|-
|021
|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;"| Глобальный идентификатор записи
|-
|022
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}district>'''}}
|
|
| style="width:52em;"|
|-
|023
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}locality>'''}}
|dt:Locality
|[0..1]
| style="width:52em;"| Населённый пункт
|-
|024
|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;"| Глобальный идентификатор записи
|-
|025
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}locality>'''}}
|
|
| style="width:52em;"|
|-
|026
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}subLocality>'''}}
|dt:Locality
|[0..1]
| style="width:52em;"| Населённый пункт, подчиненный другогому населенному пункту (locality)
|-
|027
|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;"| Глобальный идентификатор записи
|-
|028
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}subLocality>'''}}
|
|
| style="width:52em;"|
|-
|029
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}street>'''}}
|dt:Street
|[0..1]
| style="width:52em;"| Улица
|-
|030
|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;"| Глобальный идентификатор записи
|-
|031
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}street>'''}}
|
|
| style="width:52em;"|
|-
|032
|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;"| Номер дома
|-
|033
|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;"| Номер строения
|-
|034
|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;"| Номер квартиры / офиса
|-
|035
|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;"| Почтовый индекс
|-
|036
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}address>'''}}
|
|
| style="width:52em;"|
|-
|037
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}enterprise>'''}}
|
|
| style="width:52em;"|
|-
|038
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getRussianEnterpriseListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getRussianEnterpriseListResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}enterpriseList {{color|Red|count&#61;}}{{color|#007f15|"?"}} {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}}>'''}}
|dt:EnterpriseList
|[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;">
* total - всего записей;
* offset - смещение относительно первого элемента;
* count - количество выводимых записей</div>
</div>
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}enterprise>'''}}
|dt:Enterprise
|[0..*]
| style="width:52em;"| Данные о площадке
|-
|004
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор версии записи
|-
|005
|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;"| Глобальный идентификатор записи
|-
|006
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
|xs:boolean
|[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;">
* true - запись активна;
* false - запись не активна</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
|xs:boolean
|[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;">
* true - да;
* false - нет</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|bs:VersionStatus
|[1..1]
| style="width:52em;"| Статус записи
|-
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Дата создания записи
|-
|010
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Дата последнего изменения записи
|-
|011
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|bs:UUID
|[0..1]
| style="width:52em;"| Идентификатор предыдущей версии записи
|-
|012
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Полное наименование площадки
|-
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}type>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}type>'''}}
|dt:EnterpriseType
|[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;">
* 1 - предприятие;
* 2 - рынок;
* 3 - СББЖ;
* 4 - судно</div>
</div>
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}numberList>'''}}
|dt:EnterpriseNumberList
|[0..1]
| style="width:52em;"| Список номеров площадок
|-
|015
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}enterpriseNumber>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}enterpriseNumber>'''}}
|bs:String255
|[1..*]
| style="width:52em;"| Номер площадки
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}numberList>'''}}
|
|
| style="width:52em;"|
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}address>'''}}
|dt:Address
|[1..1]
| style="width:52em;"| Фактический адрес расположения площадки
|-
|018
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}}
|dt:Country
|[1..1]
| style="width:52em;"| Страна
|-
|019
|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;"| Глобальный идентификатор записи
|-
|020
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование страны
|-
|021
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}country>'''}}
|
|
| style="width:52em;"|
|-
|022
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|dt:Region
|[1..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:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование региона
|-
|025
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}region>'''}}
|
|
| style="width:52em;"|
|-
|026
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}district>'''}}
|dt:District
|[0..1]
| style="width:52em;"| Район
|-
|027
|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;"| Глобальный идентификатор записи
|-
|028
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование района
|-
|029
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}district>'''}}
|
|
| style="width:52em;"|
|-
|030
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}locality>'''}}
|dt:Locality
|[0..1]
| style="width:52em;"| Город
|-
|031
|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;"| Глобальный идентификатор записи
|-
|032
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование города
|-
|033
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}locality>'''}}
|
|
| style="width:52em;"|
|-
|034
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}subLocality>'''}}
|dt:Locality
|[0..1]
| style="width:52em;"| Населённый пункт
|-
|035
|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;"| Глобальный идентификатор записи
|-
|036
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование населенного пункта
|-
|037
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}subLocality>'''}}
|
|
| style="width:52em;"|
|-
|038
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}street>'''}}
|dt:Street
|[0..1]
| style="width:52em;"| Улица
|-
|039
|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;"| Глобальный идентификатор записи
|-
|040
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование улицы
|-
|041
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}street>'''}}
|
|
| style="width:52em;"|
|-
|042
|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;"| Номер дома
|-
|043
|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;"| Номер строения
|-
|044
|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;"| Номер квартиры / офиса
|-
|045
|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;"| Почтовый индекс
|-
|046
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}postBox>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}postBox>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| Абонентский ящик
|-
|047
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}additionalInfo>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}additionalInfo>'''}}
|bs:NText
|[0..1]
| style="width:52em;"| Дополнительная информация
|-
|048
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}addressView>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}addressView>'''}}
|bs:NText
|[0..1]
| style="width:52em;"| Строковое представление адреса
|-
|049
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}address>'''}}
|
|
| style="width:52em;"|
|-
|050
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}activityList>'''}}
|dt:EnterpriseActivityList
|[0..1]
| style="width:52em;"| Виды деятельности площадки
|-
|051
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}activity>'''}}
|dt:EnterpriseActivity
|[1..*]
| style="width:52em;"| Деятельность, осуществляемая площадкой
|-
|052
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Уникальный идентификатор записи
|-
|053
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:NText
|[1..1]
| style="width:52em;"| Название вида деятельности
|-
|054
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}activity>'''}}
|
|
| style="width:52em;"|
|-
|055
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}activityList>'''}}
|
|
| style="width:52em;"|
|-
|056
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}owner>'''}}
|dt:BusinessEntity
|[0..1]
| style="width:52em;"| ХС-владелец площадки
|-
|057
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Идентификатор версии записи
|-
|058
|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;"| Глобальный идентификатор записи
|-
|059
|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;"| Полное наименование хозяйствующего субъекта
|-
|060
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}fio>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fio>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| ФИО физического лица или индивидуального предпринимателя
|-
|061
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}juridicalAddress>'''}}
|dt:Address
|[0..1]
| style="width:52em;"| Юридический адрес
|-
|062
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}addressView>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}addressView>'''}}
|bs:NText
|[0..1]
| style="width:52em;"| Строковое представление адреса
|-
|063
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}juridicalAddress>'''}}
|
|
| style="width:52em;"|
|-
|064
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}owner>'''}}
|
|
| style="width:52em;"|
|-
|065
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}officialRegistration>'''}}
|dt:EnterpriseOfficialRegistration
|[0..*]
| style="width:52em;"| Факт постановки на учёт в налоговом органе
|-
|066
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}businessEntity>'''}}
|dt:BusinessEntity
|[1..1]
| style="width:52em;"| Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе
|-
|067
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}inn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}inn>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| ИНН хозяйствующего субъекта
|-
|068
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}businessEntity>'''}}
|
|
| style="width:52em;"|
|-
|069
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}kpp>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}kpp>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Код причины постановки на учёт (КПП)
|-
|070
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}officialRegistration>'''}}
|
|
| style="width:52em;"|
|-
|071
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}registryStatus>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}registryStatus>'''}}
|dt:EnterpriseStatus
|[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;">
* UNVERIFIED - Не подтверджен (не в реестре)
* VERIFIED - Подтвержден (включен в реестр)
* CANCELED - Исключен из реестра
* DELETED - Удален</div>
</div>
|-
|072
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}enterprise>'''}}
|
|
| style="width:52em;"|
|-
|073
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}enterpriseList>'''}}
|
|
| style="width:52em;"|
|-
|074
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getRussianEnterpriseListResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Текущая версия на 13:52, 30 мая 2024

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

Код Описание операции
ES.HRT.3.3 Получение списка площадок, зарегистрированных на территории РФ, с возможностью фильтрации

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRussianEnterpriseListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
003 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

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

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

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

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:enterprise> dt:Enterprise [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:numberList> dt:EnterpriseNumberList [0..1] Список номеров площадок
011 ·········<dt:enterpriseNumber>?</dt:enterpriseNumber> bs:String255 [1..*] Номер площадки
012 ······</dt:numberList>
013 ······<dt:address> dt:Address [0..1] Фактический адрес расположения площадки
014 ·········<dt:country> dt:Country [0..1] Страна
015 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
016 ·········</dt:country>
017 ·········<dt:region> dt:Region [0..1] Регион
018 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
019 ·········</dt:region>
020 ·········<dt:district> dt:District [0..1] Район
021 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
022 ·········</dt:district>
023 ·········<dt:locality> dt:Locality [0..1] Населённый пункт
024 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
025 ·········</dt:locality>
026 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
027 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
028 ·········</dt:subLocality>
029 ·········<dt:street> dt:Street [0..1] Улица
030 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
031 ·········</dt:street>
032 ·········<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
033 ·········<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
034 ·········<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
035 ·········<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
036 ······</dt:address>
037 ···</dt:enterprise>
038 </ws:getRussianEnterpriseListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRussianEnterpriseListResponse>
002 ···<dt:enterpriseList count="?" total="?" offset="?"> dt:EnterpriseList [1..1]

Список площадок

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей
003 ······<dt:enterprise> dt:Enterprise [0..*] Данные о площадке
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Флаг активности записи

  • true - запись активна;
  • false - запись не активна
007 ·········<bs:last>?</bs:last> xs:boolean [1..1]

Флаг, указывающий на то, что запись является последней в истории

  • true - да;
  • false - нет
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус записи
009 ·········<bs:createDate>?</bs:createDate> xs:dateTime [1..1] Дата создания записи
010 ·········<bs:updateDate>?</bs:updateDate> xs:dateTime [1..1] Дата последнего изменения записи
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
012 ·········<dt:name>?</dt:name> bs:String255 [1..1] Полное наименование площадки
013 ·········<dt:type>?</dt:type> dt:EnterpriseType [1..1]

Тип площадки

  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно
014 ·········<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров площадок
015 ············<dt:enterpriseNumber>?</dt:enterpriseNumber> bs:String255 [1..*] Номер площадки
016 ·········</dt:numberList>
017 ·········<dt:address> dt:Address [1..1] Фактический адрес расположения площадки
018 ············<dt:country> dt:Country [1..1] Страна
019 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
020 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
021 ············</dt:country>
022 ············<dt:region> dt:Region [1..1] Регион
023 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
024 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона
025 ············</dt:region>
026 ············<dt:district> dt:District [0..1] Район
027 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
028 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района
029 ············</dt:district>
030 ············<dt:locality> dt:Locality [0..1] Город
031 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
032 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование города
033 ············</dt:locality>
034 ············<dt:subLocality> dt:Locality [0..1] Населённый пункт
035 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
036 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
037 ············</dt:subLocality>
038 ············<dt:street> dt:Street [0..1] Улица
039 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
040 ···············<dt:name>?</dt:name> bs:String255 [1..1] Наименование улицы
041 ············</dt:street>
042 ············<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
043 ············<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
044 ············<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
045 ············<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
046 ············<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
047 ············<dt:additionalInfo>?</dt:additionalInfo> bs:NText [0..1] Дополнительная информация
048 ············<dt:addressView>?</dt:addressView> bs:NText [0..1] Строковое представление адреса
049 ·········</dt:address>
050 ·········<dt:activityList> dt:EnterpriseActivityList [0..1] Виды деятельности площадки
051 ············<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая площадкой
052 ···············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
053 ···············<dt:name>?</dt:name> bs:NText [1..1] Название вида деятельности
054 ············</dt:activity>
055 ·········</dt:activityList>
056 ·········<dt:owner> dt:BusinessEntity [0..1] ХС-владелец площадки
057 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
058 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
059 ············<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
060 ············<dt:fio>?</dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя
061 ············<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
062 ···············<dt:addressView>?</dt:addressView> bs:NText [0..1] Строковое представление адреса
063 ············</dt:juridicalAddress>
064 ·········</dt:owner>
065 ·········<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе
066 ············<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе
067 ···············<dt:inn>?</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта
068 ············</dt:businessEntity>
069 ············<dt:kpp>?</dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП)
070 ·········</dt:officialRegistration>
071 ·········<dt:registryStatus>?</dt:registryStatus> dt:EnterpriseStatus [1..1]

Статус площадки в реестре ИС Цербер

  • UNVERIFIED - Не подтверджен (не в реестре)
  • VERIFIED - Подтвержден (включен в реестр)
  • CANCELED - Исключен из реестра
  • DELETED - Удален
072 ······</dt:enterprise>
073 ···</dt:enterpriseList>
074 </ws:getRussianEnterpriseListResponse>

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

TODO

См. также

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

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