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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
ВизуальныйВики-текст
Новая страница: «==Общие сведения== Метод возвращает yfpyfxtybt по её глобльному идентификатору. Этот идентифи…»
 
Перенаправление на GetPurposeByGuid
 
(не показано 5 промежуточных версий этой же участницы)
Строка 1: Строка 1:
#перенаправление [[GetPurposeByGuid]]
==Общие сведения==
==Общие сведения==


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
{{столбцы}}
{{столбец}}
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] <nowiki>(http://api.vetrf.ru/schema/cdm/base)</nowiki>
** [[UUID|bs:UUID]]
* [[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/common|argc]] <nowiki>(http://api.vetrf.ru/schema/cdm/argus/common)</nowiki>
** [[Purpose|argc:Purpose]]
{{столбец}}
* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] <nowiki>(http://www.w3.org/2001/XMLSchema)</nowiki>
** [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
** [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбцы/конец}}


==Данные запроса==
==Данные запроса==
Строка 28: Строка 43:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''purpose''' || Сущность, описывающая назначение груза || [[Purpose|argc:Purpose]] || 1
| [[#Объект ..Response/purpose|'''purpose''']] || Сущность, описывающая назначение груза || [[Purpose|argc:Purpose]] || 1
|}
|}
===Объект [[#Объект getPurposeByGuidResponse|..Response]]/'''purpose'''===
Объект содержит данные о назначении груза.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи о продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор продукции в реестре РСХН || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''createDate''' || Дата создания записи о продукции в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
|-
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Название цели || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''forSubstandard''' || Назначение для некачественных грузов || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 0..1
|-
|}
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос данных о назначении "Для личного потребления"
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</div>
</div>

Текущая версия от 13:09, 19 июля 2016

Перенаправление на:

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

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

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

  • 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>
Источник — http://help.vetrf.ru/index.php?title=GetPurposeByGUID&oldid=17114