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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 236: Строка 236:
Объект содержит список добавляемой или изменяемой продукции.
Объект содержит список добавляемой или изменяемой продукции.


{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''productItem''' || Данные о номенклатуре производителя || [[ProductItem|prod:ProductItem]] || 1
|}




===Объект ..Response/productItemList/productItem===
Объект содержит информацию о номенклатуре производителя, необходимой для внесения в справочник.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор версии записи в справочнике номенклатуры || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Уникальный идентификатор продукции в справочнике || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, показывающий активна ли данная версия записи || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''last''' || Флаг, указывающий последняя ли это версия данной записи о продукции || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]|| 1
|-
| '''status''' || Статус записи || [[VersionStatus|bs:VersionStatus]] || 1
|-
| '''createDate''' || Дата создания записи в справочнике || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата последнего обновления записи || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''name''' || Название продукции || [[String255|bs:String255]] || 1
|-
| '''productType''' || Категория продукции, к которой относится данный продукт. Первый уровень иерархии справочников продукции. || [[ProductType|prod:ProductType]] || 1
|-
| [[ModifyProducerStockListOperation#Объект ..Response/productItemList/productItem/product|'''product''']] || Тип продукции. Второй уровень иерархии справочника продукции. || [[Product|prod:Product]] || 1
|-
| [[ModifyProducerStockListOperation#Объект ..Response/productItemList/productItem/subProduct|'''subProduct''']] || Вид продукции || [[SubProduct|prod:SubProduct]] || 1
|-
| '''correspondToGost''' || Производится ли продукция в соответствии с ГОСТом || [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''gost''' || ГОСТ, в соответсвии с которым производится продукция || [[String255|bs:String255]] || 0..1
|}


===Объект ..Response/productItemList/productItem===
===Объект ..Response/productItemList/productItem/product===
 
Объект содержит информацию о виде продукции, к которому относится выпускаемый продукт.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи в справочнике || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Уникальный идентификатор вида продукции в справочнике РСХН || [[UUID|bs:UUID]] || 1
|}
 
===Объект ..Response/productItemList/productItem/subProduct===


===Объект ..Response/productItemList/product===
Объект содержит информацию о подвиде продукции, к которому относится выпускаемый продукт.


===Объект ..Response/productItemList/subProduct===
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии записи в справочнике || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Уникальный идентификатор подвида продукции в справочнике РСХН || [[UUID|bs:UUID]] || 1
|}


==Коды ошибок==
==Коды ошибок==


==Примеры запросов==
==Примеры запросов==

Версия 11:51, 4 декабря 2015

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

Данная операция предназнчена для отправки заявки на изменение реестра наименований продукции предприятия производителя. Используется для добавления новой позиции в номенклатуру проиводителя. Также может использоваться для обновления данных и для удаления позиции из списка номенклатуры производителя. Номенклатура производителя является четвёртым уровнем в справочнике продукции.

Возможные сценарии

  1. Добавление новой позиции в списки производителя.
    1. Успешное добавление новой продукци в списки производителя
    2. При повторном добавлении той же продукции в список ошибки не происходит.
  1. Обновление позиции списка
  2. Удаление позиции из списка

Входящая информация:

  • идентификатор предприятия;
  • реквизиты продукции

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

Структура данных запроса в формате ХML. 

<merc:modifyBusinessEntityRequest xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/applications" 
                                  xmlns:base="http://api.vetrf.ru/schema/cdm/base"				  
                                  xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 			          
                                  xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise"
                                  xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar"> 
    <merc:localTransactionId>{xs:NCName}</merc:localTransactionId>
    <merc:initiator>
        <base:uuid>{bs:UUID}</base:uuid>
        <com:login>{xs:NCName}</com:login>
    </merc:initiator>
    <merc:modifyProducerStockListRequest>
      <merc:modificationOperation>
           <prod:type>{bs:type}</prod:type>
              <prod:enterprise>
                 <base:guid>{bs:GUID}</base:guid>
              </prod:enterprise>
              <prod:resultingList>
                 <prod:productItem>
                       <prod:name>{bs:String255}</prod:name>
                           <prod:code>{bs:String255}</prod:code>
                           <prod:productType>{prod:productType}</prod:productType>
                           <prod:product>
                              <base:guid>{bs:GUID}</base:guid>
                           </prod:product>
                           <prod:subProduct>
                              <base:guid>{bs:GUID}</base:guid>
                           </prod:subProduct>
                           <prod:correspondToGost>{xs:boolean}</prod:correspondToGost>
                           <prod:gost>{bs:String255}</prod:gost>
                        </prod:productItem>
                     </prod:resultingList>
                  </merc:modificationOperation>
               </merc:modifyProducerStockListRequest>

Объект modifyProducerStockListRequest

Корневой элемент содержимого заявки. Содержит сведения для добавления, изменения списка производимой продукции.

Поле Описание Тип данных Обязательность
localTransactionId Идентификатор заявки в клиентской системе. xs:NCName 1
initiator Пользователь, инициирующий запрос к шлюзу. Ответственный за выполнение бизнес-операции. Должен быть указан или идентификатор, или логин. argc:User 1
modificationOperation Описание операции добавления/изменения информации о продукции. prod:PSLModificationOperation 1

Объект ..Request/modificationOperation

Объект содержит общую информацию о выполняемой операции: тип операции, причину внесения записи в реестр и информацию о продукции.

Поле Описание Тип данных Обязательность
type Тип операции:
  • CREATE - создание новой записи в списке продукции;
  • UPDATE - обновление записи о продукции в реестре;
  • DELETE - удаление записи о продукции
 bs:RegisterModificationType 1
enterprise Информация о предприятии, на котором вырабатывается продукция ent:Enterprise 1
resultingList Список продукции, добавляемой в справочник. На данный момент разрешается добавлять только по одной позиции. prod:ProductItemList 1

Объект ..Request/modificationOperation/enterprise

Объект содержит информацию об идентификаторе предприятия-площадки, на котором производится продукция.

Поле Описание Тип данных Обязательность
GUID Уникальный идентификатор предприятия-площадки в реестре РСХН bs:UUID 0..1
UUID Уникальный идентификатор записи предприятия-площадки bs:UUID 0..1

Объект ..Request/modificationOperation/resultingList

Объект содержит список единиц продукции, которую нужно добавить в справочник. На данный момент список может содержать только один элемент.

Поле Описание Тип данных Обязательность
productItem Объект, содержащий данные о продукции prod:ProductItem 1

Объект ..Request/modificationOperation/resultingList/productItem

Объект содержит необходимую справочную информацию для номенклатуры производителя.

Поле Описание Тип данных Обязательность
name Название вносимой в справочник продукции. Присваивается самим производителем. bs:String255 1
code Артикул вносимой продукции. Присваивается производителем. bs:String255 1
productType Тип вносимой продукции, один из восьми. prod:ProductType 1
product Вид вносимой продукции. prod:Product 1
subProduct Подвид продукции prod:subProduct 1
correspondToGost флаг, указывающий, что продукция производится согласно xs:boolean 1
gost ГОСТ, согласно которому производится вносимая в справочник продукция bs:String255 0..1

Объект ..Request/modificationOperation/resultingList/productItem/product

Объект содержит информацию о виде продукции. Является вторым уровнем иерархии справочника продукции.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи о продукции в справочнике. bs:UUID 0..1
GUID Глобальный уникальный идентификатор продукции bs:UUID 0..1
name Название вида продукции bs:String255 0
code Код ТНВЭД вида продукции bs:String255 0
englishName Название вида продукции на английском bs:String255 0
productType Тип продукции, к которому относится данная продукция prod:ProductType 0

Объект ..Request/modificationOperation/resultingList/productItem/subproduct

Объект содержит информацию о подвиде продукции. Это третий уровень иерархии справочника продукции.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи о подвиде продукции в справочнике. bs:UUID 0..1
GUID Глобальный уникальный идентификатор продукции bs:UUID 0..1
name Название подвида продукции bs:String255 0
code Код ТНВЭД подвида продукции bs:String255 0
englishName Название подвида продукции на английском bs:String255 0
productGuid Уникальный идентификатор вида продукции, к которому относится данный подвид bs:UUID 0

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

Структура данных ответа в формате XML. 

<modifyProducerStockListResponse xmlns="http://api.vetrf.ru/schema/cdm/mercury/applications" 
                                 xmlns:bsdef="http://api.vetrf.ru/schema/cdm/base/ws-definitions" 
                                 xmlns:arg="http://api.vetrf.ru/schema/cdm/argus" 
                                 xmlns:reg="http://api.vetrf.ru/schema/cdm/base/register"
                                 xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                                 xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/applications"
                                 xmlns:prod="http://api.vetrf.ru/schema/cdm/argus/production">
   <merc:productItemList count="1" total="1" offset="0" >
      <prod:productItem>
         <bs:uuid>{bs:UUID}</bs:uuid>
         <bs:guid>{bs:UUID}</bs:guid>
         <bs:active>{xs:boolean}</bs:active>
         <bs:last>{xs:boolean}</bs:last>
         <bs:status>{bs:VersioStatus}</bs:status>
         <bs:createDate>{xs:dateTime}</bs:createDate>
         <bs:updateDate>{xs:dateTime}</bs:updateDate>
         <prod:name>{bs:String255}</prod:name>
         <prod:productType>{prod:productType}</prod:productType>
         <prod:product>
            <bs:uuid>{bs:UUID}</bs:uuid>
            <bs:guid>{bs:UUID}</bs:guid>
         </prod:product>
         <prod:subProduct>
             <bs:uuid>{bs:UUID}</bs:uuid>
             <bs:guid>{bs:UUID}</bs:guid>
         </prod:subProduct>
         <prod:correspondToGost>{xs:boolean}</prod:correspondToGost>
         <prod:gost>{bs:String255}</prod:gost>
      </prod:productItem>
    </merc:productItemList>
</modifyProducerStockListResponse>

Объект modifyProducerStockListResponse

Объект содержит информацию о позиции номенклатуры производителя, внесённой в список.

Поле Описание Тип данных Обязательность
productItemList Список продукции, в которую внесены изменения. На данный момент список может состоять только из одного элемента. prod:ProductItemList 1

Объект ..Response/productItemList

Объект содержит список добавляемой или изменяемой продукции.

Поле Описание Тип данных Обязательность
productItem Данные о номенклатуре производителя prod:ProductItem 1


Объект ..Response/productItemList/productItem

Объект содержит информацию о номенклатуре производителя, необходимой для внесения в справочник.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор версии записи в справочнике номенклатуры bs:UUID 1
GUID Уникальный идентификатор продукции в справочнике bs:UUID 1
active Флаг, показывающий активна ли данная версия записи xs:boolean 1
last Флаг, указывающий последняя ли это версия данной записи о продукции xs:boolean 1
status Статус записи bs:VersionStatus 1
createDate Дата создания записи в справочнике xs:dateTime 1
updateDate Дата последнего обновления записи xs:dateTime 1
name Название продукции bs:String255 1
productType Категория продукции, к которой относится данный продукт. Первый уровень иерархии справочников продукции. prod:ProductType 1
product Тип продукции. Второй уровень иерархии справочника продукции. prod:Product 1
subProduct Вид продукции prod:SubProduct 1
correspondToGost Производится ли продукция в соответствии с ГОСТом xs:boolean 1
gost ГОСТ, в соответсвии с которым производится продукция bs:String255 0..1

Объект ..Response/productItemList/productItem/product

Объект содержит информацию о виде продукции, к которому относится выпускаемый продукт.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии записи в справочнике bs:UUID 1
GUID Уникальный идентификатор вида продукции в справочнике РСХН bs:UUID 1

Объект ..Response/productItemList/productItem/subProduct

Объект содержит информацию о подвиде продукции, к которому относится выпускаемый продукт.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии записи в справочнике bs:UUID 1
GUID Уникальный идентификатор подвида продукции в справочнике РСХН bs:UUID 1

Коды ошибок

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

Источник — http://help.vetrf.ru/index.php?title=ModifyProducerStockListOperation&oldid=15005