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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «== Общие сведения == {| class="wikitable" ! style="text-align:left;"|Код !! style="text-align:left;"|Описание операции |- | '''IS...»)
 
Строка 103: Строка 103:
|-
|-
|001
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getRegionChangesListResponse>'''}}
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getRegionListByCountryResponse>'''}}
|
|
|
|
Строка 109: Строка 109:
|-
|-
|002
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}CounList {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}regionList {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|dt:EntityList
|dt:EntityList
|[1..1]
|[1..1]
Строка 120: Строка 120:
|-
|-
|003
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}country>'''}}
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}region>'''}}
|dt:Country
|dt:Region
|[0..*]
|[0..*]
| style="width:52em;"| Данные о стране
| style="width:52em;"| Данные о стране
Строка 162: Строка 162:
|008
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|xs:boolean
|bs:VersionStatus
|[1..1]
|[1..1]
| style="width:52em;"| Статус записи
| style="width:52em;"| Статус записи
Строка 193: Строка 193:
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|bs:String255
|[1..1]
|[0..1]
| style="width:52em;"| Наименование страны
| style="width:52em;"| Наименование страны
|-
|-
|014
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fullName>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}englishName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}englishName>'''}}
|bs:String255
|bs:String255
|[1..1]
|[0..1]
| style="width:52em;"| Полное наименование страны
| style="width:52em;"| Полное наименование страны
|-
|-
|015
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}englishName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}englishName>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}view>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}view>'''}}
|bs:String255
|bs:Strign255
|[1..1]
|[1..1]
| style="width:52em;"| Наименование страны (англ.)
| style="width:52em;"| Строковое название населенного пункта
|-
|-
|-
|016
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}regionCode>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}regionCode>'''}}
|dt:Code
|xs:string
|[1..1]
|[1..1]
| style="width:52em;"| Двухбуквенный код страны, соответствующий стандарту ISO 3166-1
| style="width:52em;"| Код региона
|-
|-
|-
|017
|017
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}code3>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code3>'''}}
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}type>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}type>'''}}
|dt:Code3
|bs:String255
|[1..1]
|[1..1]
| style="width:52em;"| Трехбуквенный код страны, соответствующий стандарту ISO 3166-1
| style="width:52em;"| Название типа адресного объекта
|-
|-
|018
|018
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}country>'''}}
|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:}}region>'''}}
|
|
|
|
| style="width:52em;"|  
| style="width:52em;"|
|-
|-
|019
|021
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}CountryList>'''}}
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}regionList>'''}}
|
|
|
|
| style="width:52em;"|
| style="width:52em;"|
|-
|-
|020
|022
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getRegionChangesListResponse>'''}}
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getRegionListByCountryResponse>'''}}
|
|
|
|

Версия 12:50, 23 мая 2024

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

Код Описание операции
IS.MERC.2.4 Получение истории изменений справочника регионов за заданный интервал времени

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRegionChangesListRequest>
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.
006 ···</bs:listOptions>
007 ···<bs:updateDateInterval> bs:DateInterval [0..1]

Тип, с помощью которого задается временной интервал

  • В список попадают все записи, дата обновлений которых попадает в указанный интервал
008 ······<bs:beginDate>?</bs:beginDate> xs:dateTime [0..1] Начало временного интервала
009 ······<bs:endDate>?</bs:endDate> xs:dateTime [0..1] Конец временного интервала
010 ···</bs:updateDateInterval>
011 </ws:getRegionChangesListRequest>

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

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

Список стран

  • total - всего записей
  • offset - смещение относительно первого элемента
  • count - количество выводимых записей
003 ······<dt:region> dt:Region [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 ·········<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<dt:name>?</dt:name> bs:String255 [0..1] Наименование страны
014 ·········<dt:englishName>?</dt:englishName> bs:String255 [0..1] Полное наименование страны
015 ·········<dt:view>?</dt:view> bs:Strign255 [1..1] Строковое название населенного пункта
016 ·········<dt:regionCode>?</dt:regionCode> xs:string [1..1] Код региона
017 ·········<dt:type>?</dt:type> bs:String255 [1..1] Название типа адресного объекта
018 ·········<dt:countryGuid>?</dt:countryGuid> bs:UUID [1..1] Глобальный идентификатор города
019 ·········<dt:hasStreets>?</dt:hasStreets> xs:boolean [1..1]

Флаг указывающий на наличие улиц

  • true - запись активна;
  • false - запись не активна.
020 ······</dt:region>
021 ···</dt:regionList>
022 </ws:getRegionListByCountryResponse>

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

TODO

См. также

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

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