ModifyActivityLocationsOperation v2
Общие сведения
В системе Меркурий ведется учет участников хозяйственной деятельности - хозяйствующих субъектов:
- юридических лиц;
- физических лиц;
- индивидуальных предпринимателей.
У хозяйствующих субъектов есть места осуществления данной деятельности - площадки. Площадкой может быть сооружение, здание, или участок местности (например, охотохозяйство). Хозяйствующий субъект связан с площадкой так называемым "отношением": хозяйствующий субъект может владеть объектом, либо использовать его, например, на правах аренды. Так же у одного хозяйствующего субъекта может быть несколько используемых площадок, либо несколько объектов, которые находятся в его владении.
В рамках операции ModifyActivityLocationsOperation доступны следующие действия:
- создание связи между площадкой и хозяйствующим субъектом с поддержкой сохранения списка GLN для пары. После создания связи хозяйствующий субъект может использовать данную площадку в системе Меркурий;
- удаление связи между хозяйствующим субъектом и площадкой с указанным идентификатором, если ХС более не использует площадку;
- обновление списка GLN для связи ХС-площадка. При этом список GLN удаляется полностью и вносится заново.
При выполнении операции ModifyActivityLocationsOperation на вход системы передаются следующие сведения:
- информация о пользователе - инициаторе запроса;
- тип операции (добавление, удаление связи или обновление GLN);
- информация о хозяйствующем субъекте и месте осуществления деятельности - площадке с которой необходимо создать/удалить связь.
- список GLN для площадки (опционально).
Результатом выполнения операции в зависимости от ее типа является:
- создание связи между хозяйствующим субъектом и площадкой;
- удаление связи между хозяйствующим субъектом и площадкой;
- обновление списка GLN для связи между хозяйствующим субъектом и площадкой.
Возможные сценарии
- 1.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом создана.
- 1.2. Произошла ошибка при обработке запроса.
- • Некорректный запрос.
- • Внутренняя ошибка системы.
- 2.1. Запрос успешно обработан. Связь между площадкой и хозяйствующем субъектом удалена.
- 2.2. Произошла ошибка при обработке запроса.
- • Некорректный запрос.
- • Внутренняя ошибка системы.
- 3.1. Запрос успешно обработан. Список GLN обновлен.
- 3.2. Произошла ошибка при обработке запроса.
- • Некорректный запрос.
- • Внутренняя ошибка системы.
Используемые типы и пространства имен
|
|
Данные запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:modifyActivityLocationsRequest> | |||
002 | ···<merc:localTransactionId>A0001</merc:localTransactionId> | xs:NCName | [1..1] | Идентификатор заявки в клиентской системе. |
003 | ···<merc:initiator> | vd:User | [1..1] | Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу.
|
004 | ······<vd:login>user_ab_150101</vd:login> | xs:NCName | [1..1] | Логин пользователя, зарегистрированного в системе Меркурий. |
005 | ···</merc:initiator> | |||
006 | ···<merc:modificationOperation> | vd:BEActivityLocationsModificationOperation | [1..1] | Описание операции создания/удаления связи между площадкой и хозяйствующим субъектом. |
007 | ······<vd:type>CREATE</vd:type> | bs:RegisterModificationType | [1..1] | Тип операции.
|
008 | ······<vd:businessEntity> | dt:BusinessEntity | [1..1] | Информация о хозяйствующем субъекте.
|
009 | ·········<bs:uuid>UUID</bs:uuid> | bs:UUID | [0..1] | Идентификатор хозяйствующего субъекта. |
010 | ·········<bs:guid>GUID</bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор хозяйствующего субъекта. |
011 | ······</vd:businessEntity> | |||
012 | ······<vd:activityLocation> | dt:BusinessMember | [1..*] | Список предприятий, для которых должна измениться привязка к хозяйствующему субъекту. |
013 | ·········<vd:globalID>3764127946134</vd:globalID> | dt:GLNType | [0..*] | Global Location Number - уникальный номер площадки хозяйствующего субъекта. |
014 | ·········<vd:enterprise> | dt:Enterprise | [1..1] | Информация о предприятии (площадке).
|
015 | ············<bs:uuid>UUID</bs:uuid> | bs:UUID | [0..1] | Идентификатор версии площадки. |
016 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [0..1] | Глобальный идентификатор площадки. |
017 | ·········</vd:enterprise> | |||
018 | ······</vd:activityLocation> | |||
019 | ···</merc:modificationOperation> | |||
020 | </merc:modifyActivityLocationsRequest> |
Данные ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <merc:modifyActivityLocationsResponse> | |||
002 | ···<merc:businessEntity> | dt:BusinessEntity | [1..1] | Информация о хозяйствующем субъекте и месте осуществления его деятельности (площадке). |
003 | ······<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии хозяйствующего субъекта. |
004 | ······<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор хозяйствующего субъекта. |
005 | ······<bs:active>true</bs:active> | xs:boolean | [1..1] | Флаг: является ли запись активной.
|
006 | ······<bs:last>true</bs:last> | xs:boolean | [1..1] | Флаг: является ли версия записи последней.
|
007 | ······<bs:status>200</bs:status> | bs:VersionStatus | [1..1] | Статус версии хозяйствующего субъекта.
|
008 | ······<bs:createDate>2018-02-08T11:08:27+03:00</bs:createDate> | xs:DateTime | [1..1] | Дата создания хозяйствующего субъекта. |
009 | ······<bs:updateDate>2018-02-08T11:08:27+03:00</bs:updateDate> | xs:DateTime | [1..1] | Дата изменения хозяйствующего субъекта. |
010 | ······<bs:previous>UUID</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи. |
011 | ······<bs:next>UUID</bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи. |
012 | ······<dt:type>1</dt:type> | dt:BusinessEntityType | [1..1] | Тип создаваемого или редактируемого хозяйствующего субъекта.
|
013 | ······<dt:name>Наименование</dt:name> | bs:String255 | [0..1] | Наименование хозяйствующего субъекта без указания организационно-правовой формы. |
014 | ······<dt:incorporationForm> | dt:IncorporationForm | [0..1] | Организационно-правовая форма хозяйствующего субъекта. |
015 | ·········<bs:uuid>UUID</bs:uuid> | bs:UUID | [0..1] | Идентификатор версии организационно-правовой формы |
016 | ·········<dt:name>Общество с ограниченной ответственностью</dt:name> | bs:String255 | [0..1] | Название организационно-правовой формы предприятия согласно справочнику ОКОПФ. |
017 | ·········<dt:code>12300</dt:code> | bs:String255 | [0..1] | Код организационно-правовой формы предприятия согласно справочнику ОКОПФ. |
018 | ·········<dt:shortName>ООО</dt:shortName> | bs:String255 | [0..1] | Краткое название организационно-правовой формы предприятия. |
019 | ······</dt:incorporationForm> | |||
020 | ······<dt:fullName>Полное наименование</dt:fullName> | bs:String255 | [0..1] | Полное наименование хозяйствующего субъекта с указанием ОПФ. |
021 | ······<dt:fio>Иванов Сергей Петрович</dt:fio> | bs:String255 | [0..1] | ФИО физического лица или индивидуального предпринимателя. |
022 | ······<dt:inn>3312200096</dt:inn> | bs:String255 | [1..1] | ИНН хозяйствующего субъекта. |
023 | ······<dt:kpp>163501001</dt:kpp> | bs:String255 | [0..1] | Код причины постановки на учет (КПП). |
024 | ······<dt:ogrn>4085022240002</dt:ogrn> | bs:String255 | [0..1] | ОГРН или ОГРНИП. |
025 | ······<dt:juridicalAddress> | dt:Address | [1..1] | Юридический адрес - адрес, по которому зарегистрирован хозяйствующий субъект. |
026 | ·········<dt:country> | dt:Country | [1..1] | Страна. |
027 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор страны в соответствии со справочником РСХН. |
028 | ·········</dt:country> | |||
029 | ·········<dt:region> | dt:Region | [1..1] | Регион (республика, область, край, автономная область). |
030 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор региона в соответствии со справочником РСХН. |
031 | ·········</dt:region> | |||
032 | ·········<dt:district> | dt:District | [0..1] | Район региона. |
033 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор района региона в соответствии со справочником РСХН. |
034 | ·········</dt:district> | |||
035 | ·········<dt:locality> | dt:Locality | [1..1] | Населённый пункт. |
036 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. |
037 | ·········</dt:locality> | |||
038 | ·········<dt:subLocality> | dt:Locality | [0..1] | Населённый пункт, подчиненный другогому населенному пункту (locality) |
039 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор населенного пункта в соответствии со справочником РСХН. |
040 | ·········</dt:subLocality> | |||
041 | ·········<dt:street> | dt:Street | [0..1] | Улица |
042 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор улицы в соответствии со справочником РСХН. |
043 | ·········</dt:street> | |||
044 | ·········<dt:house>6</dt:house> | bs:String255 | [0..1] | Номер дома. |
045 | ·········<dt:building>1</dt:building> | bs:String255 | [0..1] | Номер строения. |
046 | ·········<dt:room>1</dt:room> | bs:String255 | [0..1] | Номер квартиры / офиса. |
047 | ·········<dt:postIndex>600037</dt:postIndex> | bs:String255 | [0..1] | Почтовый индекс. |
048 | ·········<dt:postBox>а/я 56</dt:postBox> | bs:String255 | [0..1] | Абонентский ящик |
049 | ·········<dt:additionalInfo>Доп. инфо</dt:additionalInfo> | bs:String255 | [0..1] | Дополнительная информация. |
050 | ·········<dt:addressView>Адрес строкой</dt:addressView> | bs:String255 | [0..1] | Строковое представление адреса. |
051 | ······</dt:juridicalAddress> | |||
052 | ······<dt:activityLocation> | dt:BusinessMember | [1..*] | Список предприятий, для которых должна измениться привязка к хозяйствующему субъекту. |
053 | ·········<vd:globalID>3764127946134</vd:globalID> | dt:GLNType | [0..*] | Global Location Number - уникальный номер площадки хозяйствующего субъекта. |
054 | ·········<vd:enterprise> | dt:Enterprise | [1..1] | Информация о предприятии (площадке). |
055 | ············<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии площадки. |
056 | ············<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор площадки. |
057 | ·········</vd:enterprise> | |||
058 | ······</dt:activityLocation> | |||
059 | ···</merc:businessEntity> | |||
060 | </merc:modifyActivityLocationsResponse> |
Коды ошибок
В таблице ниже приведены коды ошибок, возвращаемые веб-сервисом при различных несоответствиях формату или бизнес-правилам.
- MERC05xxx - ошибки при создании связи ХС с площадкой
- MERC06xxx - ошибки при удалении связи ХС с площадкой
Таблица кодов ошибок для ModifyActivityLocationsOperation v2.0
Код ошибки | Сообщение об ошибке |
---|---|
MERC05001 | Изменить сведения о хозяйствующем субъекте может он сам или хозяйствующий субъект, добавивший его в реестр |
MERC05002 | В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции |
MERC05003 | Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции |
MERC05004 | В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН |
MERC05005 | Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату |
MERC05166 | В запросе отсутствуют сведения о хозяйствующем субъекте |
MERC05174 | Хозяйствующий субъект с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату |
MERC05175 | В запросе для хозяйствующего субъекта указан идентификатор устаревшей версии записи реестра РСХН. |
MERC05176 | Идентификатор хозяйствующего субъекта (GUID) обязателен для заполнения |
MERC05180 | Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату |
MERC05182 | Идентификатор предприятия (GUID) обязателен для заполнения |
MERC05299 | Регион указанной организации и обслуживаемого предприятия должны совпадать |
MERC05299 | Регион указанной организации и обслуживаемого предприятия должны совпадать |
MERC05306 | Пользователь с указанным идентификатором заблокирован |
MERC05320 | Идентификатор пользователя обязателен для заполнения |
MERC05360 | Список предприятий не должен быть пустым |
MERC05361 | Связь с указанным предприятием уже существует |
MERC05365 | Указанный ГЛН предприятия не соответствует правилам |
MERC05369 | Инициатор, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату. |
MERC05387 | Пользователь-инициатор запроса обязателен для заполнения |
MERC05393 | В запросе указана организация пользователя и хозяйстующий субъект, должно быть указано что-то одно |
MERC05394 | В запросе не указана ни организация пользователя, ни хозяйстующий субъект |
MERC05395 | Организация пользователя-инициатора запроса не найдена в реестре РСХН |
MERC05396 | В запросе указана неактивная организация пользователя-инициатора |
MERC05398 | Указанный инициатор не связан с ГВЭ региона указанной организации |
MERC05399 | Инициатор запроса должен быть сотрудником ВУ или иметь доступ в ГВЭ |
MERC05401 | Для хозяйствующео субъекта - инициатора запроса указана организация |
MERC05402 | Указанный инициатор не связан с хозяйствующим субъектом |
MERC06001 | Изменить сведения о хозяйствующем субъекте может он сам или хозяйствующий субъект, добавивший его в реестр |
MERC06002 | В запросе отсутствуют сведения о хозяйствующем субъекте, ответственном за выполнение операции |
MERC06003 | Отсутствует идентификатор (GUID) хозяйствующего субъекта, ответственного за выполнение операции |
MERC06004 | В запросе для хозяйствующого субъекта ответственного за выполнение операции указан идентификатор устаревшей версии записи реестра РСХН |
MERC06005 | Хозяйствующий субъект, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату |
MERC06166 | В запросе отсутствуют сведения о хозяйствующем субъекте |
MERC06174 | Хозяйствующий субъект с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату |
MERC06175 | В запросе для хозяйствующего субъекта указан идентификатор устаревшей версии записи реестра РСХН. |
MERC06176 | Идентификатор хозяйствующего субъекта (GUID) обязателен для заполнения |
MERC06180 | Предприятие с указанным идентификатором не найдено в реестре РСХН, либо идентификатор не соответствует установленному формату |
MERC06181 | В запросе для предприятия указан идентификатор устаревшей версии записи реестра РСХН. |
MERC06182 | Идентификатор предприятия (GUID) обязателен для заполнения |
MERC06306 | Пользователь с указанным идентификатором заблокирован |
MERC06320 | Идентификатор пользователя обязателен для заполнения |
MERC06360 | Список предприятий не должен быть пустым |
MERC06362 | Связь с указанным предприятием отсутствует |
MERC06369 | Инициатор, ответственный за выполнение операции, с указанным идентификатором не найден в реестре РСХН, либо идентификатор не соответствует установленному формату. |
MERC06387 | Пользователь-инициатор запроса обязателен для заполнения |
MERC06393 | В запросе указана организация пользователя и хозяйстующий субъект, должно быть указано что-то одно |
MERC06394 | В запросе не указана ни организация пользователя, ни хозяйстующий субъект |
MERC06395 | Организация пользователя-инициатора запроса не найдена в реестре РСХН |
MERC06396 | В запросе указана неактивная организация пользователя-инициатора |
MERC06398 | Указанный инициатор не связан с ГВЭ региона указанной организации |
MERC06399 | Инициатор запроса должен быть сотрудником ВУ или иметь доступ в ГВЭ |
MERC06401 | Для хозяйствующео субъекта - инициатора запроса указана организация |
MERC06402 | Указанный инициатор не связан с хозяйствующим субъектом |
Примеры запросов
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>