Herriot:GetAnimalSpeciesList:v1.0

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

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

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getAnimalSpeciesListRequest>
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:animalSpecies> dt:AnimalSpecies [0..1] Биологический вид
007 ······<dt:name>?</dt:name> bs:String255 [0..1] Наименование биологического вида
008 ······<dt:code>?</dt:code> bs:String255 [0..1] Код биологического вида
009 ···</dt:animalSpecies>
010 </ws:getAnimalSpeciesListRequest>

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

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

Список биологических видов

  • count - размер текущей страницы списка
  • offset - смещение относительного первого элемента списка
  • hasMore - признак, что текущая страница общего списка не является последней
003 ······<dt:animalSpecies> dt:AnimalSpecies [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:code>?</dt:code> bs:String255 [1..1] Код биологического вида
014 ······</dt:animalSpecies>
015 ···</dt:animalSpeciesList>
016 </ws:getAnimalSpeciesListResponse>

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

TODO

См. также

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