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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Полностью удалено содержимое страницы)
Метка: очистка
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
== Общие сведения ==


{| class="wikitable"
! style="text-align:left;"|Код !! style="text-align:left;"|Описание операции
|-
| '''IS.MERC.4.2'''
| Получение населённых пунктов заданного района
|-
|}
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getLocalityListByDistrictRequest>'''}}
|
|
| 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:}}districtGuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}districtGuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор района
|-
|007
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getLocalityListByDistrictRequest>'''}}
|
|
| style="width:52em;"|
|-
|}
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getLocalityListByDistrictResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}localityList {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|dt:EntityList
|[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 - количество выводимых записей
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}locality>'''}}
|dt:Locality
|[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|bs:}}next>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}next>'''}}
|bs:UUID
|[0..1]
| style="width:52em;"| Идентификатор следующей версии записи
|-
|013
|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;"| Наименование населенного пункта
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}englishName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}englishName>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| Наименование населенного пункта (англ.)
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}view>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}view>'''}}
|bs:Strign255
|[1..1]
| style="width:52em;"| Строковое название населенного пункта
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}regionCode>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}regionCode>'''}}
|xs:string
|[1..1]
| style="width:52em;"| Код региона
|-
|-
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}type>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}type>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Тип населенного пункта
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}countryGuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}countryGuid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор страны, к которой относится населенный пункт
|-
|019
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}hasStreets>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}hasStreets>'''}}
|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>
|-
|020
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}locality>'''}}
|
|
| style="width:52em;"|
|-
|021
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}localityList>'''}}
|
|
| style="width:52em;"| 
|-
|022
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getLocalityListByDistrictResponse>'''}}
|
|
| style="width:52em;"|
|-
|}
== Примеры запросов ==
'''TODO'''
== См. также ==
[[#top|Вернуться к началу &uarr;]]</br>
[[MercuryG2B:Services:v3.0|Вернуться на страницу профиля API MercuryG2B:Services:v3.0]]
[[Category:MercuryG2B]]
[[Category:MercuryG2B:GetLocalityListByRegion]]

Текущая версия на 18:07, 13 июня 2024

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