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

Версия 13:27, 20 ноября 2017

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

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

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

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

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

создание связи между площадкой и хозяйствующим субъектом с поддержкой сохранения списка GLN для пары. После создания связи хозяйствующий субъект может использовать данную площадку в системе Меркурий;
удаление связи между хозяйствующим субъектом и площадкой с указанным идентификатором, если ХС более не использует площадку;
обновление списка GLN для связи ХС-площадка. При этом список GLN удаляется полностью и вносится заново.

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

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

Результатом выполнения операции в зависимости от ее типа является:

создание связи между хозяйствующим субъектом и площадкой;
удаление связи между хозяйствующим субъектом и площадкой;
обновление списка GLN для связи между хозяйствующим субъектом и площадкой.

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

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

1.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом создана.

1.2. Произошла ошибка при обработке запроса.

• Некорректный запрос.

• Внутренняя ошибка системы.

2. Удаление связи между площадкой и хозяйствующим субъектом.

2.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом удалена.

2.2. Произошла ошибка при обработке запроса.

• Некорректный запрос.

• Внутренняя ошибка системы.

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

3.1. Запрос успешно обработан. Список GLN обновлен.

3.2. Произошла ошибка при обработке запроса.

• Некорректный запрос.

• Внутренняя ошибка системы.

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

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

dt (http://api.vetrf.ru/schema/cdm/dictionary)

vd (http://api.vetrf.ru/schema/cdm/mercury/vet-document)
- vd:BEActivityLocationsModificationOperation

xs (http://www.w3.org/2001/XMLSchema)

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

#	Название XML-элемента	Тип	Обязат.	Описание	Пример
1	<merc:modifyActivityLocationsRequest>
2	···<merc:localTransactionId>	xs:NCName	[1..1]	Идентификатор заявки в клиентской системе.	<bs:guid>A00001</bs:guid>
3	···<merc:initiator>	dt:User	[1..1]	Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу. Является ответственным за выполнение бизнес-операции. Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт.
4	······<vd:login>	xs:NCName	[1..1]	Логин пользователя, зарегистрированного в системе Меркурий.	<vd:login>user_ab_150101</vd:login>
5	···</merc:initiator>
6	···<merc:modificationOperation>	vd:BEActivityLocationsModificationOperation	[1..1]	Описание операции создания/удаления связи между площадкой и хозяйствующим субъектом.
7	······<vd:type>	bs:RegisterModificationType	[1..1]	Тип операции: CREATE - создание связи между площадкой и хозяйствующим субъектом; DELETE - удаление связи между площадкой и хозяйствующим субъектом.	<vd:type>CREATE</vd:type>
8	······<vd:businessEntity>	dt:BusinessEntity	[1..1]	Информация о хозяйствующем субъекте.
9	·········<bs:uuid>	bs:UUID	[0..1]	Идентификатор хозяйствующего субъекта.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
10	·········<bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор хозяйствующего субъекта.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
11	······</vd:businessEntity>
12	······<vd:activityLocation>	dt:BusinessMember	[1..*]	Список предприятий, для которых должна измениться привязка к хозяйствующему субъекту.
13	·········<vd:globalID>	dt:GLNType	[0..*]	Global Location Number - уникальный номер площадки хозяйствующего субъекта, на которой он осуществляет деятельность. См. http://www.gs1.org/gln.	<vd:globalID>3764127946134</vd:globalID>
14	·········<vd:enterprise>	dt:Enterprise	[1..1]	Элемент, содержащий информацию о поднадзорном объекте.
15	············<bs:uuid>	bs:UUID	[0..1]	Идентификатор версии поднадзорного объекта.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
16	············<bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор поднадзорного объекта.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
17	·········</vd:enterprise>
18	······</vd:activityLocation>
19	···</merc:modificationOperation>
20	</merc:modifyActivityLocationsRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание	Пример
1	<merc:modifyActivityLocationsResponse>
2	···<merc:businessEntity>	dt:BusinessEntity	[1..1]	Информация о хозяйствующем субъекте и месте осуществления его деятельности (площадке).
3	······<bs:uuid>	bs:UUID	[1..1]	Идентификатор версии хозяйствующего субъекта.	<bs:uuid>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:uuid>
4	······<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор хозяйствующего субъекта.	<bs:guid>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:guid>
5	······<bs:active>	xs:boolean	[1..1]	Является ли запись хозяйствующего субъекта активной: true - запись активна; false - запись не активна.	<bs:active>true</bs:active>
6	······<bs:last>	xs:boolean	[1..1]	Последняя версия номенклатуры: true - да; false - нет.	<bs:last>true</bs:last>
7	······<bs:status>	bs:VersionStatus	[1..1]	Статус версии хозяйствующего субъекта.	<bs:status></bs:status>
8	······<bs:createDate>	xs:DateTime	[1..1]	Дата создания хозяйствующего субъекта.	<bs:createDate>2017-07-07T12:00:00</bs:createDate>
9	······<bs:updateDate>	xs:DateTime	[1..1]	Дата изменения хозяйствующего субъекта.	<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
10	······<bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи реестра хозяйствующих субъектов.	<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
11	······<bs:next>	bs:UUID	[0..1]	Идентификатор следующей версии записи реестра хозяйствующих субъектов.	<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
12	······<dt:type>	dt:BusinessEntityType	[1..1]	Тип создаваемого или редактируемого хозяйствующего субъекта: 1 - юридическое лицо; 2 - физическое лицо; 3 - индивидуальный предприниматель.	<dt:type>1</dt:type>
13	······<dt:incorporationForm>	dt:IncorporationForm	[0..1]	Организационно-правовая форма хозяйствующего субъекта. Обязательно указывается только для юридических лиц. Для физических лиц и для индивидуальных предпринимателей поле не указывается.
14	·········<dt:name>	bs:String255	[0..1]	Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. Указывается только в случае добавления/изменения сведений о хозяйствующем субъекте - юридическом лице.	<dt:name>Общество с ограниченной ответственностью</dt:name>
15	·········<dt:code>	bs:String255	[1..1]	Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. Указывается только в случае добавления/изменения сведений о хозяйствующем субъекте - юридическом лице.	<dt:code>12300</dt:code>
16	·········<dt:shortName>	bs:String255	[0..1]	Краткое название организационно-правовой формы предприятия. Указывается только в случае добавления/изменения сведений о хозяйствующем субъекте - юридическом лице.	<dt:shortName>ООО</dt:shortName>
17	······</dt:incorporationForm>
18	······<dt:name>	bs:String255	[0..1]	Наименование хозяйствующего субъекта без указания организационно-правовой формы. Обязательно указывается только для юридических лиц. Для физических лиц и для индивидуальных предпринимателей поле не указывается.	<dt:name>Гладиолус</dt:name>
19	······<dt:fullName>	bs:String255	[0..1]	Полное наименование хозяйствующего субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП. Обязательно указывается только для юридических лиц. Для физических лиц и для индивидуальных предпринимателей поле не указывается.	<dt:fullName>Общество с ограниченной ответственностью "Гладиолус"</dt:fullName>
20	······<dt:fio>	bs:String255	[0..1]	ФИО физического лица или индивидуального предпринимателя. Обязательно указывается при создании хозяйствующего субъекта - ИП или физического лица. Для юридических лиц поле не указывается.	<dt:fio>Иванов Сергей Петрович</dt:fio>
21	······<dt:inn>	bs:String255	[0..1]	ИНН хозяйствующего субъекта. Указывается 10 цифр для юридических лиц. Указывается 12 цифр для физических лиц и ИП. Обязательно указывается только для юридических лиц. Для физических лиц поле не указывается.	<dt:inn>3312200096</dt:inn>
22	······<dt:kpp>	bs:String255	[0..1]	Код причины постановки на учет. Указывается только для юридических лиц, поле необязательно для заполнения. Для физических лиц и для индивидуальных предпринимателей поле не указывается.	<dt:kpp>163501001</dt:kpp>
23	······<dt:ogrn>	bs:String255	[0..1]	ОГРН или ОГРНИП. Обязательно указывается только для юридических лиц. Для ИП ОГРНИП можно не указывать. Для физических лиц поле не указывается.	<dt:ogrn>4085022240002</dt:ogrn>
24	······<dt:juridicalAddress>	dt:Address	[1..1]	Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект. При создании хозяйствующего субъекта обязательным является указание идентификатора страны, региона, района или города (для городов регионального подчинения) и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица. Для городов федерального подчинения указывается страна, регион (название города) и улица, где зарегистрирован ХС.
25	·········<dt:country>	dt:Country	[1..1]	Страна, в которой зарегистрирован хозяйствующий субъект.
26	············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор страны в соответствии со справочником РСХН.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
27	············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор страны в соответствии со справочником РСХН.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
28	·········</dt:country>
29	·········<dt:region>	dt:Region	[1..1]	Регион страны, в которой зарегистрирован хозяйствующий субъект.
30	············<bs:uuid>	bs:UUID	[1..1]	Уникальный идентификатор региона страны в соответствии со справочником РСХН.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
31	············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор региона страны в соответствии со справочником РСХН.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
32	·········</dt:region>
33	·········<dt:locality>	dt:Locality	[0..1]	Город региона страны (город регионального подчинения), где зарегистрирован хозяйствующий субъект.
34	············<bs:uuid>	bs:UUID	[0..1]	Уникальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
35	············<bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор города региона (города регионального подчинения) страны в соответствии со справочником РСХН.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
36	·········</dt:locality>
37	·········<dt:district>	dt:Locality	[0..1]	Район региона страны, где зарегистрирован хозяйствующий субъект.
38	············<bs:uuid>	bs:UUID	[0..1]	Уникальный идентификатор района региона в соответствии со справочником РСХН.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
39	············<bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор района региона в соответствии со справочником РСХН.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
40	·········</dt:district>
41	·········<dt:street>	dt:Street	[0..1]	Улица города, где зарегистрирован хозяйствующий субъект Обязательно для заполнения при регистриации хозяйствующих субъектов в городах федерального значения.
42	············<bs:uuid>	bs:UUID	[0..1]	Уникальный идентификатор улица города страны в соответствии со справочником РСХН.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
43	············<bs:guid>	bs:UUID	[0..1]	Глобальный идентификатор улица города в соответствии со справочником РСХН.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
44	·········</dt:street>
45	·········<dt:house>	bs:String255	[0..1]	Номер дома.	<dt:house>6</dt:house>
46	·········<dt:building>	bs:String255	[0..1]	Номер строения.	<dt:building>1</dt:building>
47	·········<dt:room>	bs:String255	[0..1]	Номер квартиры / офиса.	<dt:room>1</dt:room>
48	·········<dt:postIndex>	bs:String255	[0..1]	Почтовый индекс.	<dt:postIndex>600037</dt:postIndex>
49	·········<dt:postBox>	bs:String255	[0..1]	Абонентский ящик	<dt:postBox>а/я 56</dt:postBox>
50	·········<dt:additionalInfo>	bs:String255	[0..1]	Дополнительная информация.	<dt:additionalInfo>Доп. инфо</dt:additionalInfo>
51	·········<dt:addressView>	bs:String255	[0..1]	Строковое представление адреса.	<dt:addressView>Российская Федерация, Владимирская обл., г. Владимир, ул. Ленина ул., д. 44</dt:addressView>
52	······</dt:juridicalAddress>
53	······<dt:activityLocation>	dt:BusinessMember	[1..*]	Список предприятий, для которых должна измениться привязка к хозяйствующему субъекту.
54	·········<dt:globalID>	dt:GLNType	[0..*]	Global Location Number - уникальный номер площадки хозяйствующего субъекта, на которой он осуществляет деятельность. См. http://www.gs1.org/gln.	<dt:globalID>3764127946134</dt:globalID>
55	·········<dt:enterprise>	dt:Enterprise	[1..1]	Элемент, содержащий информацию о поднадзорном объекте.
56	············<bs:uuid>	bs:UUID	[1..1]	Идентификатор версии поднадзорного объекта.	<bs:uuid>53557240-35e7-48c8-81ce-8b9948cfef90</bs:uuid>
57	············<bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор поднадзорного объекта.	<bs:guid>2c779c29-1fc2-44a6-8add-92752657f089</bs:guid>
58	·········</dt:enterprise>
59	······</dt:activityLocation>
60	···</merc:businessEntity>
61	</merc:modifyActivityLocationsResponse>

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

1. Создание связи ХС-площадка

Запрос 1.1 - Добавление предприятия ХС.

<SOAP-ENV:Envelope xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:merc="http://api.vetrf.ru/schema/cdm/mercury/g2b/applications/v2" xmlns:apldef="http://api.vetrf.ru/schema/cdm/application/ws-definitions" xmlns:apl="http://api.vetrf.ru/schema/cdm/application" xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <apldef:submitApplicationRequest>
      <apldef:apiKey>apikey</apldef:apiKey>
      <apl:application>
        <apl:serviceId>mercury-g2b.service:2.0</apl:serviceId>
        <apl:issuerId>issuerId</apl:issuerId>
        <apl:issueDate>2017-09-22T15:53:04</apl:issueDate>
        <apl:data>
          <merc:modifyActivityLocationsRequest>
            <merc:localTransactionId>a1797722714</merc:localTransactionId>
            <merc:initiator>
              <vd:login>user_login</vd:login>
            </merc:initiator>
            <merc:modificationOperation>
              <vd:type>CREATE</vd:type>
              <vd:businessEntity>
                <bs:guid>fcd89443-218a-11e2-a69b-b499babae7ea</bs:guid>
              </vd:businessEntity>
              <vd:activityLocation>
                <vd:globalID>7574894948562</vd:globalID>
                <vd:globalID>5412345123453</vd:globalID>
                <vd:enterprise>
                  <bs:guid>351d096d-0c5d-46a8-b5b1-67c3e26bff78</bs:guid>
                </vd:enterprise>
              </vd:activityLocation>
            </merc:modificationOperation>
          </merc:modifyActivityLocationsRequest>
        </apl:data>
      </apl:application>
    </apldef:submitApplicationRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

@@ Строка 39: / Строка 39: @@
 :: • Внутренняя ошибка системы.
-===Используемые пространства имен ===
+===Используемые типы и пространства имен ===
 {{столбцы}}
 {{столбец}}

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

Версия 13:27, 20 ноября 2017

Содержание

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

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

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

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

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

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

1. Создание связи ХС-площадка

Навигация

Поиск