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

Текущая версия на 23:11, 10 октября 2020

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

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

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

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

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

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

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getPurposeListRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка.
003	······<bs:count>10</bs:count>	xs:nonNegativeInteger	[0..1]	Максимальное запрашиваемое количество объектов в списке. По умолчанию значение 100; Максимально возможное значение 1000.
004	······<bs:offset>2</bs:offset>	xs:nonNegativeInteger	[0..1]	Номер элемента, по которому осуществляется смещение первого элемента списка. По умолчанию значение 0.
005	···</bs:listOptions>
006	</ws:getPurposeListRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getPurposeListResponse>
002	···<dt:purposeList total="2" offset="0" count="2">	dt:PurposeList	[1..1]	Список назначений груза. total - всего записей; offset - смещение относительно первого элемента; count - количество выводимых записей.
003	······<dt:purpose>	dt:Purpose	[0..*]	Назначение груза.
004	·········<bs:uuid>UUID</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии назначения груза.
005	·········<bs:guid>GUID</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор назначения груза.
006	·········<bs:active>true</bs:active>	xs:boolean	[1..1]	Описывает, является ли запись активной. true - запись активна; false - запись не активна.
007	·········<bs:last>true</bs:last>	xs:boolean	[1..1]	Описывает, является ли версия записи последней. true - да; false - нет.
008	·········<bs:status>100</bs:status>	bs:VersionStatus	[1..1]	Статус версии назначения груза.
009	·········<bs:createDate>2017-07-07T12:00:00</bs:createDate>	xs:DateTime	[1..1]	Дата создания назначения груза.
010	·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>	xs:DateTime	[1..1]	Дата изменения назначения груза.
011	·········<bs:previous>UUID</bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи.
012	·········<dt:name>в корм животным</dt:name>	bs:String255	[1..1]	Наименование назначения груза.
013	······</dt:purpose>
014	···</dt:purposeList>
015	</ws:getPurposeListResponse>

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

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

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

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

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

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
      <v2:getPurposeListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
         <dt:purposeList count="3" total="210" offset="0">
            <dt:purpose>
               <bs:uuid>fedc91a0-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
               <bs:guid>5b914aea-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-24T15:13:08+04:00</bs:createDate>
               <bs:updateDate>2009-04-24T15:13:08+04:00</bs:updateDate>
               <dt:name>адсорбация микотоксинов в кормах для с/х животных, в том числе птиц</dt:name>
            </dt:purpose>
            <dt:purpose>
               <bs:uuid>fedc99e8-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
               <bs:guid>5b915b5e-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-21T15:26:10+04:00</bs:createDate>
               <bs:updateDate>2009-05-21T15:26:10+04:00</bs:updateDate>
               <dt:name>адсорбция афлатоксина В1 и предотвращение развития плесени в кормах для свиней и с/х птицы</dt:name>
            </dt:purpose>
            <dt: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+04:00</bs:createDate>
               <bs:updateDate>2009-04-15T16:50:49+04:00</bs:updateDate>
               <dt:name>аукцион</dt:name>
            </dt:purpose>
         </dt:purposeList>
      </v2:getPurposeListResponse>
   </soap:Body>
</soapenv:Envelope>