Herriot:GetAnimalBreedList:v1.0

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

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

Операция GetAnimalBreedList предназначена для получения актуального списка пород животных.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getAnimalBreedListRequest>
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:animalBreed> dt:AnimalBreed [0..1] Порода
007 ······<dt:name>?</dt:name> bs:String255 [0..1] Наименование породы
008 ······<dt:species> dt:AnimalSpecies [0..1] Биологический вид животного
009 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
010 ······</dt:species>
011 ···</dt:animalBreed>
012 </ws:getAnimalBreedListRequest>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getAnimalBreedListResponse>
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 ·········<dt:name>?</dt:name> bs:String255 [1..1] Наименование породы
013 ·········<dt:species> dt:AnimalSpecies [1..1] Биологический вид животного, к которому относится данная порода
014 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
015 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование биологчиеского вида
016 ············<dt:code>?</dt:code> bs:String255 [1..1] Код биологического вида
017 ·········</dt:species>
018 ······</dt:animalBreed>
019 ···</dt:animalBreedList>
020 </ws:getAnimalBreedListResponse>

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

TODO