GetPurposeList: различия между версиями

Версия 11:27, 12 декабря 2016

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

Операция GetPurposeList предназначена для получения списка актуальных версий назначений груза (active=true, last=true). Операция поддерживает постраничный вывод.

Используемые пространства имён и типы

bs (http://api.vetrf.ru/schema/cdm/base)
- bs:UUID

argc (http://api.vetrf.ru/schema/cdm/argus/common)
- argc:Purpose
- argc:PurposeList

xs (http://www.w3.org/2001/XMLSchema)

Входные данные

параметры выводимого списка.

Выходные данные

список актуальных записей назначений груза.

Данные запроса

Объект getPurposeListRequest

Корневой объект запроса. В нём указаны параметры запрашиваемого списка.

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры запрашиваемого списка.	bs:ListOptions	0..1

Объект ..Request/listOptions

Объект содержит в себе параметры запрашиваемого списка.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке. По умолчанию значение равно 100; Максимально допустимое значение равно 1000.	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала.	xs:nonNegativeInteger	0..1

Данные ответа

Объект getPurposeListResponse

Корневой элемент ответа. Содержит информацию о списке изменённых целей.

Поле	Описание	Тип данных	Обязательность
purposeList	Сущность, описывающая список назначений груза.	argc:PurposeList	1

Объект ..Response/purposeList

Содержит в себе объекты, описывающие назначение перемещения груза.

Поле	Описание	Тип данных	Обязательность
purpose	Сущность, описывающая назначение груза.	argc:Purpose	1

Атрибуты списка purposeList

Атрибут	Описание	Тип данных	Обязательность
count	Количество элементов списка, запрашиваемое или переданное.	xs:int	1
total	Общий размер списка.	xs:long	1
offset	Смещение первого элемента списка относительно его начала.	xs:int	1

Объект ..Response/purposeList/purpose

Объект содержит данные о назначении груза.

Поле	Описание	Тип	Обязательность
UUID	Идентификатор версии записи о назначении груза в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор назначения груза в реестре Россельхознадзора.	bs:UUID	1
active	Флаг, указывающий на то, активна ли запись.	xs:boolean	1
last	Флаг, указывающий на то, является ли запись последней.	xs:boolean	1
status	Статус версии записи.	xs:string	1
createDate	Дата создания записи о назначении груза в реестре Россельхознадзора.	xs:dateTime	1
updateDate	Дата последнего обновления записи в реестре Россельхознадзора.	xs:dateTime	1
previous	Идентификатор предыдущей версии записи.	bs:UUID	0..1
name	Название цели (назначения груза).	xs:string	0..1

Описание ошибок

Ошибка	Описание
InternalServiceFault	Внутренняя ошибка сервиса.
IncorrectRequestFault	Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.

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

Запрос первых трех назначений груза, со смещением равным двум.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getPurposeListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>2</base:offset>
      </base:listOptions>
    </ws:getPurposeListRequest>
  </soapenv:Body>
</soapenv:Envelope>

Ответ на запрос.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getPurposeListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                               xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 
                               xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
      <com:purposeList count="3" total="197" offset="2">
        <com:purpose>
          <bs:uuid>fedc43a8-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>5b913ae4-e089-11e1-bcf3-b499babae7ea</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2009-04-15T16:50:49+03:00</bs:createDate>
          <bs:updateDate>2009-04-15T16:50:49+03:00</bs:updateDate>
          <com:name>аукцион</com:name>
        </com:purpose>
        <com:purpose>
          <bs:uuid>fedc4948-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>5b9141c8-e089-11e1-bcf3-b499babae7ea</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2009-04-22T17:59:26+03:00</bs:createDate>
          <bs:updateDate>2009-04-22T17:59:26+03:00</bs:updateDate>
          <com:name>в качестве подстилки</com:name>
        </com:purpose>
        <com:purpose>
          <bs:uuid>fedc97d6-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>5b9157cd-e089-11e1-bcf3-b499babae7ea</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2009-05-18T17:14:01+03:00</bs:createDate>
          <bs:updateDate>2009-05-18T17:14:01+03:00</bs:updateDate>
          <com:name>в качестве удобрения</com:name>
        </com:purpose>
      </com:purposeList>
    </ws:getPurposeListResponse>
  </S:Body>
</soapenv:Envelope>

@@ Строка 1: / Строка 1: @@
 ==Общие сведения==
-Операция '''GetPurposeList''' предназначена для получения актуальных версий назначений груза (active=true, last=true) на текущую дату. Операция поддерживает постраничный вывод.
+Операция '''GetPurposeList''' предназначена для получения списка актуальных версий назначений груза (active=true, last=true). Операция поддерживает постраничный вывод.
 ===Используемые пространства имён и типы===