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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Egorova-iv-150707 переименовал страницу ModifyActivityLocationsOperation в ModifyActivityLocationsOperation v1.2)
 
Строка 1: Строка 1:
#перенаправление [[ModifyActivityLocationsOperation v1.2]]
==Общие сведения==
В системе Меркурий ведется учет участников хозяйственной деятельности - хозяйствующих субъектов:
* юридических лиц;
* физических лиц;
* индивидуальных предпринимателей.
У хозяйствующих субъектов есть места осуществления данной деятельности - площадки. Площадкой может быть сооружение, здание, или участок местности (например, охотохозяйство). Хозяйствующий субъект связан с площадкой так называемым "отношением": хозяйствующий субъект может владеть объектом, либо использовать его, например, на правах аренды. Так же у одного хозяйствующего субъекта может быть несколько используемых площадок, либо несколько объектов, которые находятся в его владении.
Операция '''ModifyActivityLocationsOperation''' позволяет устанавливать такое "отношение", создавая связь между площадкой и хозяйствующим субъектом. Так же данная операция предназначена и для удаления связи, если хозяйствующих субъект более не использует площадку.
После создания связи хозяйствующий субъект может использовать данную площадку в системе Меркурий.
 
При выполнении операции '''ModifyActivityLocationsOperation''' на вход системы передаются следующие сведения:
* информация о пользователе - инициаторе запроса;
* тип операции (добавление или удаление связи);
* информация о хозяйствующем субъекте и месте осуществления деятельности - площадке с которой необходимо создать/удалить связь.
 
Результатом выполнения операции является создание связи между хозяйствующим субъектом и площадкой или удаление этой связи.
 
===Возможные сценарии===
<div id = "createLocation">1. [[#scenario1|Создание связи между площадкой и хозяйствующем субъектом.]]</div>
:1.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом создана.<br />
:1.2. Произошла ошибка при обработке запроса.
:: • Некорректный запрос.
:: • Внутренняя ошибка системы.
<div id = "deleteLocation">2. [[#scenario2|Удаление связи между площадкой и хозяйствующим субъектом.]]</div>
:2.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом удалена.<br />
:2.2. Произошла ошибка при обработке запроса.
:: • Некорректный запрос.
:: • Внутренняя ошибка системы.
 
===Пространства имён и типы===
{{столбцы}}
{{столбец}}
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/enterprise|ent]] (<nowiki>http://api.vetrf.ru/schema/cdm/cerberus/enterprise</nowiki>)
**[[BEActivityLocationsModificationOperation|ent:BEActivityLocationsModificationOperation]]
**[[BusinessEntity|ent:BusinessEntity]]
**[[EnterpriseList|ent:EnterpriseList]]
**[[Enterprise|ent:Enterprise]]
**[[BusinessEntityType|ent:BusinessEntityType]]
**[[IncorporationForm|ent:IncorporationForm]]
**[[ActivityLocation|ent:ActivityLocation]]
{{столбец}}
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
**[[UUID|bs:UUID]]
**[[RegisterModificationType|bs:RegisterModificationType]]
**[[VersionStatus|bs:VersionStatus]]
**[[String255|bs:String255]]
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/argus/common|argc]] (<nowiki>http://api.vetrf.ru/schema/cdm/argus/common</nowiki>)
** [[User|argc:User]]
{{столбец}}
*[[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
**[[Address|ikar:Address]]
**[[country|ikar:country]]
**[[region|ikar:region]]
*[[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]](<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
**[http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
**[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
**[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
{{столбцы/конец}}
 
==Данные запроса==
<!--- <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<mercvu:modifyActivityLocationsRequest xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/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">
    <mercvu:localTransactionId>123456</mercvu:localTransactionId>
    <mercvu:initiator>
        <base:uuid>{bs:UUID}</base:uuid>
        <com:login>{xs:NCName}</com:login>
    </mercvu:initiator>
    <mercvu: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>
    </mercvu:modificationOperation>
</mercvu:modifyActivityLocationsRequest>
</syntaxhighlight>
</div>
</div> -->
 
===Объект modifyActivityLocationsRequest===
 
Корневой элемент содержимого заявки. Содержит сведения для создания/удаления связи между площадкой и хозяйствующим субъектом.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''localTransationId''' || Идентификатор транзакции в клиентской системе. || [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]|| 1
|-
| [[#Объект ..Request/initiator|'''initiator''']] || Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Ответственный за выполнение бизнес-операции. Должен быть указан или идентификатор, или логин пользователя в системе Меркурий. || [[User|argc:User]] || 1
|-
| [[#Объект ..Request/modificationOperation|'''modificationOperation''']] || Описание операции создания/удаления связи между площадкой и хозяйствующим субъектом.|| [[BEActivityLocationsModificationOperation|ent:BEActivityLocationsModificationOperation]] || 1
|}
 
===Объект [[#Объект modifyActivityLocationsRequest|..Request]]/'''initiator'''===
 
Содержит сведения о пользователе, зарегистрированном в системе Меркурий и инициирующим запрос к шлюзу.
{| class="wikitable"
|-
! Поле !! Описание !! Тип !! Обязательность
|-
| '''UUID'''
| Идентификатор пользователя, зарегистрированного в системе Меркурий.
| [[UUID|bs:UUID]]
| rowspan=2 | 1 - обязательно должно быть заполнено хотя бы одно из полей, либо UUID, либо login.<br>
При указании обоих полей, приоритет у UUID.
|-
| '''login'''
| Логин пользователя.
| [http://www.w3.org/TR/xmlschema-2/#NCName xs:NCName]
|}
 
===Объект [[#Объект modifyActivityLocationsRequest|..Request]]/'''modificationOperation'''===
Объект содержит общие сведения о выполняемой операции: тип операции, информацию о поднадзорном объекте и хозяйствующем субъекте.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''type''' || Тип операции:
*CREATE - создание связи между площадкой и хозяйствующим субъектом;
*DELETE - удаление связи между площадкой и хозяйствующим субъектом.
|| [[RegisterModificationType|bs:RegisterModificationType]] || 1
|-
| [[#Объект ..Request/modificationOperation/businessEntity|'''businessEntity''']] || Информация о хозяйствующем субъекте. || [[BusinessEntity|ent:BusinessEntity]] || 1
|-
| [[#Объект ..Request/modificationOperation/enterpriseList|'''enterpriseList''']] || Элемент содержит сведения о списке поднадзорных объектов.
* На данный момент за одну операцию можно создать/удалить связь только с одним поднадзорным объектом.
|| [[EnterpriseList|ent:EnterpriseList]] || 1
|}
 
===Объект [[#Объект  modifyActivityLocationsRequest|..Request]]/[[#Объект ..Request/modificationOperation|modificationOperation]]/'''businessEntity'''===
Объект содержит сведения о хозяйствующем субъекте.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии хозяйствующего субъекта - владельца продукции. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта - владельца продукции. || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект  modifyActivityLocationsRequest|..Request]]/[[#Объект ..Request/modificationOperation|modificationOperation]]/'''enterpriseList'''===
Объект содержит сведения о списке поднадзорных объектов.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
|[[#Объект ..Request/modificationOperation/enterpriseList/enterprise|'''enterprise''']]  || Информация о площадке с которой создается/удаляется связь. || [[Enterprise|ent:Enterprise]] || 1
|}
 
===Объект [[#Объект  modifyActivityLocationsRequest|..Request]]/[[#Объект ..Request/modificationOperation|modificationOperation]]/[[#Объект ..Request/modificationOperation/enterpriseOperation|enterpriseList]]/'''enterprise'''===
Объект содержит сведения о поднадзорном объекте.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Идентификатор версии предприятия. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор предприятия. || [[UUID|bs:UUID]] || 1
|}
 
==Данные ответа==
<!-- <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Структура данных ответа в формате ХML.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<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>
</syntaxhighlight>
</div>
</div> -->
 
===Объект modifyActivityLocationsResponse===
Объект содержит информацию о хозяйствующем субъекте и площадке, над которыми была выполнена операция.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/businessEntity|'''businessEntity''']] || Информация о хозяйствующем субъекте и месте осуществления его деятельности (площадке). || [[BusinessEntity|ent:BusinessEntity]] || 1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/'''businessEntity'''===
Объект содержит информацию о хозяйствующем субъекте и месте осуществления его деятельности (площадке).
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор хозяйствующего субъекта в реестре.  || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор хозяйствующего субъекта в реестре. || [[UUID|bs:UUID]]|| 1
|-
| '''active''' || Является ли запись активной:
* true - запись активна, т.е. содержит последние (актуальные) данные хозяйствующего субъекта;
* false - запись неактивна, т.е. данные хозяйствующего субъекта обновлялись, есть более новые версии записи.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''last''' || Является ли запись о хозяйствующем субъекте последней:
*true - запись последняя;
*false - запись не последняя.
|| [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''status''' || Текущий статус версии записи реестра хозяйствующих субъектов.
* 100 - новая запись;
* 200 - запись редактировалась.
|| [[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
|-
| '''previous''' || Идентификатор предыдущий версии записи реестра хозяйствующих субъектов.  || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Идентификатор следующей версии записи реестра хозяйствующих субъектов.  || [[UUID|bs:UUID]] || 0..1
|-
| '''type''' || Тип хозяйствующего субъекта:
*1 - юридическое лицо;
*2 - физическое лицо;
*3 - индивидуальный предприниматель.
|| [[BusinessEntityType|ent:BusinessEntityType]] || 1
|-
| '''name''' || Наименование хозяйствующего субъекта без указания организационно-правовой формы.
* Обязательно указывается только для юридических лиц.
* Для физических лиц и для индивидуальных предпринимателей поле не указывается.
|| [[String255|bs:String255]] || 0..1
|-
| [[#Объект ..Response/businessEntity/incorporationForm|'''incorporationForm''']] || Организационно-правовая форма хозяйствующего субъекта. Название указывается согласно общероссийскому классификатору организационно-правовых форм (ОКОПФ). Идентификатор организационно-правовой формы состоит из пяти знаков и вводится без пробелов.
* Обязательно указывается только для юридических лиц.
* Для физических лиц и для индивидуальных предпринимателей поле не указывается.
|| [[IncorporationForm|ent:IncorporationForm]] || 0..1
|-
| '''fullName''' || Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.
* Обязательно указывается только для юридических лиц.
* Для физических лиц и для индивидуальных предпринимателей поле не указывается.
|| [[String255|bs:String255]] || 0..1
|-
| '''fio''' || ФИО физического лица или индивидуального предпринимателя.
* Обязательно указывается при создании хозяйствующего субъекта - ИП или физического лица.
* Для юридических лиц поле не указывается.
|| [[String255|bs:String255]] || 0..1
|-
| '''inn''' || ИНН хозяйствующего субъекта.
* Указывается 10 цифр для юридических лиц.
* Указывается 12 цифр для физических лиц и ИП.
* Обязательно указывается только для юридических лиц и ИП.
* Для физических лиц поле не указывается.
|| [[String255|bs:String255]] || 0..1
|-
| '''ogrn''' || ОГРН или ОГРНИП.
* Обязательно указывается только для юридических лиц и ИП.
* Для физических лиц поле не указывается.
|| [[String255|bs:String255]] || 0..1
|-
| [[#Объект ..Response/businessEntity/juridicalAddress|'''juridicalAddress''']] ||Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект.
* При создании хозяйствующего субъекта обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.
|| [[Address|ikar:Address]] || 1
|-
| [[#Объект ..Response/businessEntity/activityLocation|'''activityLocation''']] || Место осуществления деятельности.
* Если был выбран тип операции DELETE, то поле '''activityLocation''' возвращаться не будет.
|| [[ActivityLocation|ent:ActivityLocation]] || 0..1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/'''incorporationForm'''===
Объект содержит информацию об организационно-правовой форме хозяйствующего субъекта.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID'''|| Идентификатор организационно-правовой формы в справочнике РСХН.
* Указывается только в случае добавления/изменения сведений о хозяйствующем субъекте - юридическом лице.
|| [[UUID|bs:UUID]] || 0..1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/'''juridicalAddress'''===
Объект описывает поля юридического адреса хозяйствующего субъекта.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/businessEntity/juridicalAddress/country|'''country''']] || Страна, в которой зарегистрирован хозяйствующий субъект. || [[Country|ikar:Country]] || 1
|-
| [[#Объект ..Response/businessEntity/juridicalAddress/region|'''region''']] || Регион страны, в которой зарегистрирован хозяйствующий субъект. || [[Region|ikar:Region]] || 1
|-
| addressView || Строковое представление адреса. || [[String255|bs:String255]] || 1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''country'''===
Объект содержит данные о стране, в которой зарегистрирован хозяйствующий субъект.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор страны в соответствии со справочником РСХН.|| [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор страны в соответствии со справочником РСХН.  || [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/juridicalAddress|juridicalAddress]]/'''region'''===
Объект содержит данные о регионе страны, где зарегистрирован хозяйствующий субъект.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор региона страны в соответствии со справочником РСХН. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор региона страны в соответствии со справочником РСХН.|| [[UUID|bs:UUID]] || 1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/'''activityLocation'''===
Объект содержит сведения о месте осуществления деятельности хозяйствующего субъекта.
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| [[#Объект ..Response/businessEntity/activityLocation/enterprise|'''enterprise''']] || Информация о поднадзорном объекте (площадке), с которой у хозяйствующего субъекта была создана связь.
* В случае удаления связи информация о поднадзорном объекте не возвращается.
|| [[Enterprise|ent:Enterprise]] || 0..1
|}
 
===Объект [[#Объект modifyActivityLocationsResponse|..Response]]/[[#Объект ..Response/businessEntity|businessEntity]]/[[#Объект ..Response/businessEntity/activityLocation|activityLocation]]/'''enterprise'''===
 
Объект содержит сведения о площадке - месте осуществления деятельности хозяйствующего субъекта.
 
{| class="wikitable"
|-
! Поле !! Описание !! Тип данных !! Обязательность
|-
| '''UUID''' || Уникальный идентификатор поднадзорного объекта в реестре. || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор поднадзорного объекта в реестре. || [[UUID|bs:UUID]] || 1
|}
 
==Примеры запросов==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id="scenario1">[[#createLocation|Создание связи между площадкой и хозяйствующим субъектом.]]</div>
<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/application/ws-definitions"
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                  xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/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">
  <soapenv:Header/>
  <soapenv:Body>
      <ws:submitApplicationRequest>
        <ws:apiKey>apiKey</ws:apiKey>
        <app:application>
            <app:serviceId>mercury-vu.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2015-01-10T17:03:00</app:issueDate>
            <app:data>
              <mercvu:modifyActivityLocationsRequest>
                  <mercvu:localTransactionId>a10003</mercvu:localTransactionId>
                  <mercvu:initiator>
                      <com:login>user</com:login>
                  </mercvu:initiator>
                  <mercvu: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>
                </mercvu:modificationOperation>
            </mercvu:modifyActivityLocationsRequest>
          </app:data>
        </app:application>
    </ws:submitApplicationRequest>
</soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div><br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div id="scenario2">[[#deleteLocation|Удаление связи между площадкой и хозяйствующим субъектом.]]</div>
<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/application/ws-definitions"
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application"
                  xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/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">
  <soapenv:Header/>
  <soapenv:Body>
      <ws:submitApplicationRequest>
        <ws:apiKey>apiKey</ws:apiKey>
        <app:application>
            <app:serviceId>mercury-g2b.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2015-01-10T17:03:00</app:issueDate>
            <app:data>
              <mercvu:modifyActivityLocationsRequest>
                  <mercvu:localTransactionId>a10003</mercvu:localTransactionId>
                  <mercvu:initiator>
                      <com:login>user</com:login>
                  </mercvu:initiator>
                  <mercvu: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>
                </mercvu:modificationOperation>
            </mercvu:modifyActivityLocationsRequest>
        </app:data>
      </app:application>
    </ws:submitApplicationRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
 
==Коды ошибок==
 
{| class="wikitable"
|-
! Код ошибки !! Описание
|-
| MERC05001 || Изменить сведения о хозяйствующем субъекте может он сам или хозяйствующий субъект, добавивший его в реестр.
|-
| MERC05002 || В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции.
|-
| MERC05003 || Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции.
|-
| MERC05004 || В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC05005 || Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC05166 || В запросе отсутствуют сведения о хозяйствующем субъекте.
|-
| MERC05174 || Хозяйствующий субъект с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC05175 || В запросе для хозяйствующего субъекта указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC05176 || Идентификатор хозяйствующего субъекта (GUID) обязателен для заполнения.
|-
| MERC05180 || Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC05181 || В запросе для предприятия указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC05182 || Идентификатор предприятия (GUID) обязателен для заполнения.
|-
| MERC05360 || Список предприятий не должен быть пустым.
|-
| MERC05361|| Связь с указанным предприятием уже существует.
|-
| MERC06001 || Изменить сведения о хозяйствующем субъекте может он сам или хозяйствующий субъект, добавивший его в реестр
|-
| MERC06002 || В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции.
|-
| MERC06003 || Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции.
|-
| MERC06004 || В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC06005 || Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC06166 || В запросе отсутствуют сведения о хозяйствующем субъекте.
|-
| MERC06174 || Хозяйствующий субъект с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC06175 || В запросе для хозяйствующего субъекта указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC06176 || Идентификатор хозяйствующего субъекта (GUID) обязателен для заполнения.
|-
| MERC06180 || Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
|-
| MERC06181 || В запросе для предприятия указан идентификатор устаревшей версии записи реестра РСХН.
|-
| MERC06182 || Идентификатор предприятия (GUID) обязателен для заполнения.
|-
| MERC06360 || Список предприятий не должен быть пустым.
|-
| MERC06362 || Связь с указанным предприятием отсутствует.
|}
 
[[#top|Вернуться к началу &uarr;]]
[[Category:Ветис.API]]
[[Category:изменение мест осуществления деятельности]]
[[Category:Ветис.API для ветеринарных управлений]]

Версия 19:47, 3 июня 2016

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

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

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

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

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

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

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

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

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

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

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

Объект 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

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

Объект 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

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application" 
                  xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/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">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:submitApplicationRequest>
         <ws:apiKey>apiKey</ws:apiKey>
         <app:application>
            <app:serviceId>mercury-vu.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2015-01-10T17:03:00</app:issueDate>
            <app:data>
               <mercvu:modifyActivityLocationsRequest>
                  <mercvu:localTransactionId>a10003</mercvu:localTransactionId>
                  <mercvu:initiator>
                       <com:login>user</com:login>
                  </mercvu:initiator>
                  <mercvu: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>
                 </mercvu:modificationOperation>
             </mercvu:modifyActivityLocationsRequest>
          </app:data>
        </app:application>
     </ws:submitApplicationRequest>
</soapenv:Body>
</soapenv:Envelope>



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/application/ws-definitions" 
                  xmlns:app="http://api.vetrf.ru/schema/cdm/application" 
                  xmlns:mercvu="http://api.vetrf.ru/schema/cdm/mercury/vu/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">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:submitApplicationRequest>
         <ws:apiKey>apiKey</ws:apiKey>
         <app:application>
            <app:serviceId>mercury-g2b.service</app:serviceId>
            <app:issuerId>issuerId</app:issuerId>
            <app:issueDate>2015-01-10T17:03:00</app:issueDate>
            <app:data>
               <mercvu:modifyActivityLocationsRequest>
                  <mercvu:localTransactionId>a10003</mercvu:localTransactionId>
                  <mercvu:initiator>
                      <com:login>user</com:login>
                  </mercvu:initiator>
                  <mercvu: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>
                 </mercvu:modificationOperation>
             </mercvu:modifyActivityLocationsRequest>
         </app:data>
       </app:application>
    </ws:submitApplicationRequest>
  </soapenv:Body>
</soapenv:Envelope>

Коды ошибок

Код ошибки Описание
MERC05001 Изменить сведения о хозяйствующем субъекте может он сам или хозяйствующий субъект, добавивший его в реестр.
MERC05002 В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции.
MERC05003 Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции.
MERC05004 В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН.
MERC05005 Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC05166 В запросе отсутствуют сведения о хозяйствующем субъекте.
MERC05174 Хозяйствующий субъект с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC05175 В запросе для хозяйствующего субъекта указан идентификатор устаревшей версии записи реестра РСХН.
MERC05176 Идентификатор хозяйствующего субъекта (GUID) обязателен для заполнения.
MERC05180 Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC05181 В запросе для предприятия указан идентификатор устаревшей версии записи реестра РСХН.
MERC05182 Идентификатор предприятия (GUID) обязателен для заполнения.
MERC05360 Список предприятий не должен быть пустым.
MERC05361 Связь с указанным предприятием уже существует.
MERC06001 Изменить сведения о хозяйствующем субъекте может он сам или хозяйствующий субъект, добавивший его в реестр
MERC06002 В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции.
MERC06003 Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции.
MERC06004 В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН.
MERC06005 Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC06166 В запросе отсутствуют сведения о хозяйствующем субъекте.
MERC06174 Хозяйствующий субъект с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC06175 В запросе для хозяйствующего субъекта указан идентификатор устаревшей версии записи реестра РСХН.
MERC06176 Идентификатор хозяйствующего субъекта (GUID) обязателен для заполнения.
MERC06180 Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату.
MERC06181 В запросе для предприятия указан идентификатор устаревшей версии записи реестра РСХН.
MERC06182 Идентификатор предприятия (GUID) обязателен для заполнения.
MERC06360 Список предприятий не должен быть пустым.
MERC06362 Связь с указанным предприятием отсутствует.

Вернуться к началу ↑

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