Herriot:GetAllCountryList:v1.0

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

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

Код Описание операции
IS.HRT.1.3 Получение списка всех стран

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

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

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

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

Список стран

  • total - всего записей
  • offset - смещение относительно первого элемента
  • count - количество выводимых записей
003 ······<dt:country> dt:Country [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:fullName>?</dt:fullName> bs:String255 [1..1] Полное наименование страны
015 ·········<dt:englishName>?</dt:englishName> bs:String255 [1..1] Наименование страны (англ.)
016 ·········<dt:code>?</dt:code> dt:Code [1..1] Двухбуквенный код страны, соответствующий стандарту ISO 3166-1
017 ·········<dt:code3>?</dt:code3> dt:Code3 [1..1] Трехбуквенный код страны, соответствующий стандарту ISO 3166-1
018 ······</dt:country>
019 ···</dt:countryList>
020 </ws:getAllCountryListResponse>

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

TODO

См. также

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