GetPurposeList

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

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

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

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

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

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

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

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

Запрос данных о назначении "Для личного потребления"

<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>100</base:count>
            <base:offset>0</base:offset>
         </base:listOptions>
      </ws:getPurposeListRequest>
   </soapenv:Body>
</soapenv:Envelope>