Tst

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

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

Универсальный шлюз Ветис.API
Подсистема обработки заявок в Ветис.API
Бизнес-операции:
• оформление производственной партии
• оформление транспортной партии
• оформление входящей партии
• оформление результатов инвентаризации
• объединение записей складского журнала
• получение ВСД по его идентификатору
• получение ВСД, созданных или измененных за указанный интервал дат
• получение всех ВСД предприятия с возможностью фильтрации
• получение конкретной версии записи складского журнала по ее идентификатору
• получение последней (актуальной) версии записи складского журнала по ее идентификатору
• получение всех версий записи складского журнала по ее идентификатору
• получение актуального списка записей журнала
• получение списка версий записей журнала, созданных или измененных за указанный интервал дат
• добавление/изменение сведений о хозяйствующем субъекте
• добавление/изменение сведений о поднадзорном объекте
• аннулирование ВСД
• создание/удаление связи с площадкой

В системе Меркурий ведется учет участников хозяйственной деятельности - хозяйствующий субъектов:

  • юридических лиц;
  • физических лиц;
  • индивидуальных предпринимателей.

У хозяйствующих субъектов есть места осуществления данной деятельности - площадки. Площадкой может быть сооружение, здание, или участок местности (например, охотохозяйство). Хозяйствующий субъект связан с площадкой так называемым "отношением": хозяйствующий субъект может владеть объектом, либо использовать его, например, на правах аренды. Так же у одного хозяйствующего субъекта может быть несколько используемых площадок, либо несколько объектов, которые находятся в его владении. Операция ModifyActivityLocationsOperation позволяет устанавливать такое "отношение", создавая связь между площадкой и хозяйствующим субъектом. Так же данная операция предназначена и для удаления связи, если хозяйствующих субъект более не использует площадку. После создания связи хозяйствующий субъект может использовать данную площадку в системе Меркурий.

При выполнении операции ModifyActivityLocationsOperation на вход системы передаются следующие сведения:

  • информация о пользователе - инициаторе запроса;
  • тип операции (добавление или удаление связи);
  • информация о хозяйствующем субъекте и месте осуществления деятельности - площадке с которой необходимо создать/удалить связь.

Результатом выполнения операции является создание связи между хозяйствующим субъектом и площадкой или удаление этой связи.

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

1.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом создана.
1.2. Произошла ошибка при обработке запроса.
• Некорректный запрос.
• Внутренняя ошибка системы.
2.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом удалена.
2.2. Произошла ошибка при обработке запроса.
• Некорректный запрос.
• Внутренняя ошибка системы.

Пространства имён и типы

ikar:region

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

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

<merc:modifyActivityLocationsRequest 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>123456</merc:localTransactionId>
    <merc:initiator>
        <base:uuid>{bs:UUID}</base:uuid>
        <com:login>{xs:NCName}</com:login>
    </merc:initiator>
    <merc:modificationOperation>
        <ent:type>{bs:RegisterModificationType}</ent:type>
        <ent:businessEntity>
            <base:guid>{bs:UUID}</base:guid>
       </ent:businessEntity>
       <ent:enterpriseList>
           <ent:enterprise>
               <base:guid>{bs:UUID}</base:guid>
           </ent:enterprise>
       </ent:enterpriseList>
    </merc:modificationOperation>
</merc:modifyActivityLocationsRequest>

Объект modifyActivityLocationsRequest

Корневой элемент содержимого заявки. Содержит сведения для создания/удаления связи между площадкой и хозяйствующим субъектом.

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

Объект ..Request/initiator

Содержит сведения о пользователе, зарегистрированном в системе Меркурий и инициирующим запрос к шлюзу.

Поле Описание Тип Обязательность
UUID Идентификатор пользователя, зарегистрированного в системе Меркурий. bs:UUID 1 - обязательно должно быть заполнено хотя бы одно из полей, либо UUID, либо login.

При указании обоих полей, приоритет у UUID.

login Логин пользователя. xs:NCName

Объект ..Request/modificationOperation

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

Поле Описание Тип данных Обязательность
type Тип операции:
  • CREATE - создание связи между площадкой и хозяйствующим субъектом;
  • DELETE - удаление связи между площадкой и хозяйствующим субъектом.
 bs:RegisterModificationType 1
businessEntity Информация о хозяйствующем субъекте. ent:BusinessEntity 1
enterpriseList Элемент содержит сведения о списке поднадзорных объектов.
  • На данный момент за одну операцию можно создать/удалить связь только с одним поднадзорным объектом.
 ent:EnterpriseList 1

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

Объект содержит сведения о хозяйствующем субъекте.

Поле Описание Тип данных Обязательность
UUID Идентификатор версии хозяйствующего субъекта - владельца продукции. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта - владельца продукции. bs:UUID 1

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

Объект содержит сведения о списке поднадзорных объектов.

Поле Описание Тип данных Обязательность
enterprise Информация о площадке с которой создается/удаляется связь. ent:Enterprise 1

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

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

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

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

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

<modifyActivityLocationsResponse xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/applications" 
                                 xmlns:base="http://api.vetrf.ru/schema/cdm/base" 
                                 xmlns:ent="http://api.vetrf.ru/schema/cdm/cerberus/enterprise" 
                                 xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar">
    <merc:businessEntity>
        <base:uuid>{bs:UUID}</base:uuid>
        <base:guid>{bs:UUID}</base:guid>
        <base:active>{xs:boolean}</base:active>
        <base:last>{xs:boolean}</base:last>
        <base:status>{xs:integer}</base:status>
        <base:createDate>{xs:dateTime}</base:createDate>
        <base:updateDate>{xs:dateTime}</base:updateDate>
        <ent:type>{ent:BusinessEntityType}</ent:type>
        <ent:name>{bs:String255}</ent:name>
        <ent:incorporationForm">
            <base:uuid>{bs:UUID}</base:uuid>
        </ent:incorporationForm>
        <ent:fullName>{bs:String255}</ent:fullName>
        <ent:inn>{bs:String255}</ent:inn>
        <ent:ogrn>{bs;String255}</ent:ogrn>
        <ent:juridicalAddress>
            <ikar:country>
                <base:uuid>{bs:UUID}</base:uuid>
                <base:guid>{bs:UUID}</base:guid>
            </ikar:country> 
            <ikar:region>
                <base:uuid>{bs:UUID}</base:uuid>
                <base:guid>{bs:UUID}</base:guid>
            </ikar:region>
            <ikar:addressView>{bs:String255}</ikar:addressView>
        </ent:juridicalAddress>
        <ent:activityLocation>
            <ent:enterprise>
                <base:uuid>{bs:UUID}</base:uuid>
                <base:guid>{bs:UUID}</base:guid>
            </ent:enterprise>
        </ent:activityLocation>
    </merc:businessEntity>
</modifyActivityLocationsResponse>

Объект modifyActivityLocationsResponse

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

Поле Описание Тип данных Обязательность
businessEntity Информация о хозяйствующем субъекте и месте осуществления его деятельности (площадке). ent:BusinessEntity 1

Объект ..Response/businessEntity

Объект содержит информацию о хозяйствующем субъекте и месте осуществления его деятельности (площадке).

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор хозяйствующего субъекта в реестре. bs:UUID 1
GUID Глобальный идентификатор хозяйствующего субъекта в реестре. bs:UUID 1
active Является ли запись активной:
  • true - запись активна, т.е. содержит последние (актуальные) данные хозяйствующего субъекта;
  • false - запись неактивна, т.е. данные хозяйствующего субъекта обновлялись, есть более новые версии записи.
 xs:boolean 1
last Является ли запись о хозяйствующем субъекте последней:
  • true - запись последняя;
  • false - запись не последняя.
 xs:boolean 1
status Текущий статус версии записи реестра хозяйствующих субъектов.
  • 100 - новая запись;
  • 200 - запись редактировалась.
 bs:VersionStatus 1
createDate Дата создания текущей записи в реестре. xs:dateTime 1
updateDate Дата обновления текущей записи реестра. xs:dateTime 1
previous Идентификатор предыдущий версии записи реестра хозяйствующих субъектов. bs:UUID 0..1
next Идентификатор следующей версии записи реестра хозяйствующих субъектов. bs:UUID 0..1
type Тип хозяйствующего субъекта:
  • 1 - юридическое лицо;
  • 2 - физическое лицо;
  • 3 - индивидуальный предприниматель.
 ent:BusinessEntityType 1
name Наименование хозяйствующего субъекта без указания организационно-правовой формы.
  • Обязательно указывается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не указывается.
 bs:String255 0..1
incorporationForm Организационно-правовая форма хозяйствующего субъекта. Название указывается согласно общероссийскому классификатору организационно-правовых форм (ОКОПФ). Идентификатор организационно-правовой формы состоит из пяти знаков и вводится без пробелов.
  • Обязательно указывается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не указывается.
 ent:IncorporationForm 0..1
fullName Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
  • Обязательно указывается только для юридических лиц.
  • Для физических лиц и для индивидуальных предпринимателей поле не указывается.
 bs:String255 0..1
fio ФИО физического лица или индивидуального предпринимателя.
  • Обязательно указывается при создании хозяйствующего субъекта - ИП или физического лица.
  • Для юридических лиц поле не указывается.
 bs:String255 0..1
inn ИНН хозяйствующего субъекта.
  • Указывается 10 цифр для юридических лиц.
  • Указывается 12 цифр для физических лиц и ИП.
  • Обязательно указывается только для юридических лиц и ИП.
  • Для физических лиц поле не указывается.
 bs:String255 0..1
ogrn ОГРН или ОГРНИП.
  • Обязательно указывается только для юридических лиц и ИП.
  • Для физических лиц поле не указывается.
 bs:String255 0..1
juridicalAddress Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
  • При создании хозяйствующего субъекта обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.
 ikar:Address 1
activityLocation Место осуществления деятельности.
  • Если был выбран тип операции DELETE, то поле activityLocation возвращаться не будет.
 ent:ActivityLocation 0..1

Объект ..Response/businessEntity/incorporationForm

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

Поле Описание Тип данных Обязательность
UUID Идентификатор организационно-правовой формы в справочнике РСХН.
  • Указывается только в случае добавления/изменения сведений о хозяйствующем субъекте - юридическом лице.
 bs:UUID 0..1

Объект ..Response/businessEntity/juridicalAddress

Объект описывает поля юридического адреса хозяйствующего субъекта.

Поле Описание Тип данных Обязательность
country Страна, в которой зарегистрирован хозяйствующий субъект. ikar:Country 1
region Регион страны, в которой зарегистрирован хозяйствующий субъект. ikar:Region 1
addressView Строковое представление адреса. bs:String255 1

Объект ..Response/businessEntity/juridicalAddress/country

Объект содержит данные о стране, в которой зарегистрирован хозяйствующий субъект.

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

Объект ..Response/businessEntity/juridicalAddress/region

Объект содержит данные о регионе страны, где зарегистрирован хозяйствующий субъект.

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

Объект ..Response/businessEntity/activityLocation

Объект содержит сведения о месте осуществления деятельности хозяйствующего субъекта.

Поле Описание Тип данных Обязательность
enterprise Информация о поднадзорном объекте (площадке), с которой у хозяйствующего субъекта была создана связь.
  • В случае удаления связи информация о поднадзорном объекте не возвращается.
 ent:Enterprise 0..1

Объект ..Response/businessEntity/activityLocation/enterprise

Объект содержит сведения о площадке - месте осуществления деятельности хозяйствующего субъекта.

Поле Описание Тип данных Обязательность
UUID Уникальный идентификатор поднадзорного объекта в реестре. bs:UUID 1
GUID Глобальный идентификатор поднадзорного объекта в реестре. bs:UUID 1

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

<merc:modifyActivityLocationsRequest>
    <merc:localTransactionId>a10003</merc:localTransactionId>
    <merc:initiator>
        <base:uuid>123456</base:uuid>
        <com:login>user</com:login>
    </merc:initiator>
    <merc:modificationOperation>
        <ent:type>CREATE</ent:type>
        <ent:businessEntity>
            <base:guid>54321</base:guid>
        </ent:businessEntity>
        <ent:enterpriseList>
            <ent:enterprise>
                <base:guid>6789</base:guid>
            </ent:enterprise>
        </ent:enterpriseList>
   </merc:modificationOperation>
</merc:modifyActivityLocationsRequest>



<merc:modifyActivityLocationsRequest>
    <merc:localTransactionId>a10003</merc:localTransactionId>
    <merc:initiator>
        <base:uuid>123456</base:uuid>
        <com:login>user</com:login>
    </merc:initiator>
    <merc:modificationOperation>
        <ent:type>DELETE</ent:type>
        <ent:businessEntity>
            <base:guid>54321</base:guid>
        </ent:businessEntity>
        <ent:enterpriseList>
            <ent:enterprise>
                <base:guid>6789</base:guid>
            </ent:enterprise>
        </ent:enterpriseList>
   </merc:modificationOperation>
</merc:modifyActivityLocationsRequest>

Коды ошибок

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