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

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


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getAnimalBreedChangesListRequest>'''}}
|
|
| 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|bs:}}updateDateInterval>'''}}
|bs:DateInterval
|[1..1]
| style="width:52em;"| Интервал времени обновления
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}beginDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}beginDate>'''}}
|xs:dateTime
|[1..1]
| style="width:52em;"| Начало временного интервала
|-
|008
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}endDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}endDate>'''}}
|xs:dateTime
|[0..1]
| style="width:52em;"| Конец временного интервала
|-
|009
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDateInterval>'''}}
|
|
| style="width:52em;"|
|-
|010
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getAnimalBreedChangesListRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


== Спецификация ответа ==
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getAnimalBreedChangesListResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalBreedList {{color|Red|count&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|hasMore&#61;}}{{color|#007f15|"?"}}>'''}}
|dt:AnimalBreedList
|[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;">
* count - размер текущей страницы списка
* offset - смещение относительного первого элемента списка
* hasMore - признак, что текущая страница общего списка не является последней</div>
</div>
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalBreed>'''}}
|dt:AnimalBreed
|[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
|[1..1]
| style="width:52em;"| Наименование породы
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}species>'''}}
|dt:AnimalSpecies
|[1..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:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Наименование биологического вида
|-
|017
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}code>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}code>'''}}
|bs:String255
|[1..1]
| style="width:52em;"| Код биологического вида
|-
|018
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|dt:}}species>'''}}
|
|
| style="width:52em;"|
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalBreed>'''}}
|
|
| style="width:52em;"|
|-
|020
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalBreedList>'''}}
|
|
| style="width:52em;"|
|-
|021
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getAnimalBreedChangesListResponse>'''}}
|
|
| style="width:52em;"|
|-
|}


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


'''TODO'''
'''TODO'''

Текущая версия на 03:02, 16 февраля 2024

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

Операция GetAnimalBreedChangesList предназначена для получения истории изменений справочника пород животных.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getAnimalBreedChangesListRequest>
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 ···<bs:updateDateInterval> bs:DateInterval [1..1] Интервал времени обновления
007 ······<bs:beginDate>?</bs:beginDate> xs:dateTime [1..1] Начало временного интервала
008 ······<bs:endDate>?</bs:endDate> xs:dateTime [0..1] Конец временного интервала
009 ···</bs:updateDateInterval>
010 </ws:getAnimalBreedChangesListRequest>

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

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

Список пород

  • count - размер текущей страницы списка
  • offset - смещение относительного первого элемента списка
  • hasMore - признак, что текущая страница общего списка не является последней
003 ······<dt:animalBreed> dt:AnimalBreed [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 [1..1] Наименование породы
014 ·········<dt:species> dt:AnimalSpecies [1..1] Биологический вид животного, к которому относится данная порода
015 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
016 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование биологического вида
017 ············<dt:code>?</dt:code> bs:String255 [1..1] Код биологического вида
018 ·········</dt:species>
019 ······</dt:animalBreed>
020 ···</dt:animalBreedList>
021 </ws:getAnimalBreedChangesListResponse>

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

TODO

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