GetPurposeByGuid

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

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

Метод возвращает сведения о назначении груза по его глобальному идентификатору. Этот идентификатор используется при оформлении транспортных сертификатов.

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

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

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

Объект getPurposeByGuidRequest

Корневой объект запроса. В нём указан глобальный идентификатор, по которому производится поиск назначения груза.

Поле Описание Тип данных Обязательность
GUID Глобальный идентификатор назначения записи, по которому производится поиск записи bs:UUID 1

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

Объект getPurposeByGuidResponse

Корневой элемент ответа. Содержит информацию о назначении груза.

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

Объект ..Response/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:getPurposeByGuidRequest>
         <base:guid>5b91af60-e089-11e1-bcf3-b499babae7ea</base:guid>
      </ws:getPurposeByGuidRequest>
   </soapenv:Body>
</soapenv:Envelope>