MercuryG2B:ModifyEnterprise:v3.0

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

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

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

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:modifyEnterpriseRequest>
002 ···<merc:localTransactionId>?</merc:localTransactionId> xs:NCName [1..1] Идентификатор заявки в клиентской системе
003 ···<merc:initiator> vd:User [1..1]

Пользователь, зарегистрированный в системе Меркурий и инициирующий запрос к шлюзу

  • Является ответственным за выполнение бизнес-операции
  • Здесь потребуется логин ветврача или пользователя ХС. Логин для базовой аутентификации не подойдёт
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя, зарегистрированного в системе Меркурий
005 ···</merc:initiator>
006 ···<merc:modificationOperation> vd:ENTodificationOperation [1..1] Описание операции добавления/изменения информации о площадке
007 ······<vd:type>?</vd:type> bs:RegisterModificationType [1..1]

Тип операции

На данный момент доступны операции двух типов:

  • CREATE - создание поднадзорного объекта
  • UPDATE - обновление данных поднадзорного объекта
008 ······<vd:resultingList> dt:EnterpriseList [1..1]

Список, который содержит сведения о добавляемых площадках

  • На данный момент поддерживается добавление только одной площадки в рамках одной заявки
009 ·········<dt:enterprise> dt:Enterprise [1..1] Данные о площадке
010 ············<bs:uuid>?</bs:uuid> bs:UUID [0..1]

Идентификатор версии площадки

  • Задается в запросе на изменение (тип операции UPDATE)
  • Может быть указана только последняя версия записи
011 ············<dt:name>?</dt:name> bs:String255 [1..1] Полное наименование площадки
012 ············<dt:type>?</dt:type> dt:EnterpriseType [1..1]

Тип площадки(для площадки РФ)

  • 1 - предприятие
  • 2 - рынок
  • 3 - СББЖ
  • 4 - судно
013 ············<dt:address> dt:Address [1..1]

Фактический адрес расположения площадки

  • Для российских площадок детализация адреса должна быть как минимум до locality
014 ···············<dt:country> dt:Country [1..1]

Страна

  • Достаточно указать один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
015 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор страны в соответствии со справочником РСХН
016 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор страны в соответствии со справочником РСХН
017 ···············</dt:country>
018 ···············<dt:region> dt:Region [1..1]

Регион (республика, область, край, автономная область)

  • Достаточно указать один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
019 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор региона в соответствии со справочником РСХН
020 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор региона в соответствии со справочником РСХН
021 ···············</dt:region>
022 ···············<dt:district> dt:District [0..1] Район региона
023 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор района региона в соответствии со справочником РСХН
024 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор района региона в соответствии со справочником РСХН
025 ···············</dt:district>
026 ···············<dt:locality> dt:Locality [1..1]

Населённый пункт

  • Достаточно указать один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
027 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН
028 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН
029 ···············</dt:locality>
030 ···············<dt:subLocality> dt:Locality [0..1]

Населённый пункт, подчиненный другогому населенному пункту (locality)

  • Достаточно указать один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
031 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН
032 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН
033 ···············</dt:subLocality>
034 ···············<dt:street> dt:Street [0..1]

Улица

  • Достаточно указать один из идентификаторов: uuid или guid. При указании обоих приоритет у uuid
035 ··················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор улицы в соответствии со справочником РСХН
036 ··················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор улицы в соответствии со справочником РСХН
037 ···············</dt:street>
038 ···············<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
039 ···············<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
040 ···············<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
041 ···············<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
042 ···············<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
043 ···············<dt:additionalInfo>?</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация
044 ···············<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
045 ············</dt:address>
046 ············<dt:activityList> dt:EnterpriseActivityList [1..1] Виды деятельности площадки
047 ···············<dt:activity> dt:EnterpriseActivity [1..*]

Деятельность, осуществляемая площадкой

  • Указывается согласно справочнику видов деятельности
048 ··················<dt:name>?</dt:name> bs:NText [1..1] Название вида деятельности
049 ···············</dt:activity>
050 ············</dt:activityList>
051 ············<dt:owner> dt:BusinessEntity [0..1]

Хозяйствующий субъект-собственник площадки

  • Указание owner влияет на то, сможет ли реальный владелец площадки (ХС) в дальнейшем её редактировать. По умолчанию редактировать площадку через API может только тот, кто добавил её в реестр
  • Обязательно должен быть указан uuid или guid. При указании обоих приоритет у uuid
052 ···············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии хозяйствующего субъекта
053 ···············<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор хозяйствующего субъекта
054 ············</dt:owner>
055 ············<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе
056 ···············<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе
057 ··················<dt:inn>?</dt:inn> bs:String255 [1..1]

ИНН хозяйствующего субъекта

  • Обязательно указывается ИНН хозяйствующего субъекта. В случае передачи иных полей из типа dt:BusinessEntity они будут проигнорированы
  • ИНН валидируется по контрольному числу. Требуется корректное указание ИНН
058 ···············</dt:businessEntity>
059 ···············<dt:kpp>?</dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП)
060 ············</dt:officialRegistration>
061 ·········</dt:enterprise>
062 ······</vd:resultingList>
063 ······<vd:reason>?</vd:reason> dt:ENTModificationReason [1..1] Основание добавления записи в реестр
064 ···</merc:modificationOperation>
065 </merc:modifyEnterpriseRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <merc:modifyEnterpriseResponse>
002 ···<merc:enterprise> dt:Enterprise [1..2]

Данные о площдке

  • В случае обновления записи в ответе вернутся старая запись и новая
003 ······<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии площадки
004 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор площадки
005 ······<bs:active>?</bs:active> xs:boolean [1..1]

Флаг: является ли запись активной

  • true - запись активна
  • false - запись не активна
006 ······<bs:last>?</bs:last> xs:boolean [1..1]

Флаг: является ли версия записи последней

  • true - да
  • false - нет
007 ······<bs:status>?</bs:status> bs:VersionStatus [1..1]

Статус версии площадки

008 ······<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания площадки
009 ······<bs:updateDate>?</bs:updateDate> xs:DateTime [1..1] Дата изменения площадки
010 ······<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра площадок
011 ······<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи реестра площадок
012 ······<dt:name>?</dt:name> bs:String255 [1..1] Полное наименование площадки
013 ······<dt:type>?</dt:type> dt:EnterpriseType [1..1]

Тип площадки

  • 1 - предприятие
  • 2 - рынок
  • 3 - СББЖ
  • 4 - судно
014 ······<dt:address> dt:Address [1..1]

Фактический адрес расположения площадки

  • В текущей версии для некоторых адресных объектов (кроме страны и региона) допускается возврат в ответе только GUID объекта. UUID может отсутствовать
015 ·········<dt:country> dt:Country [1..1] Страна
016 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор страны в соответствии со справочником РСХН
017 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор страны в соответствии со справочником РСХН
018 ·········</dt:country>
019 ·········<dt:region> dt:Region [1..1] Регион (республика, область, край, автономная область)
020 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор региона в соответствии со справочником РСХН
021 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор региона в соответствии со справочником РСХН
022 ·········</dt:region>
023 ·········<dt:district> dt:District [0..1] Район региона
024 ············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор района региона в соответствии со справочником РСХН
025 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор района региона в соответствии со справочником РСХН
026 ·········</dt:district>
027 ·········<dt:locality> dt:Locality [1..1] Населённый пункт.
028 ············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН
029 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН
030 ·········</dt:locality>
031 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт, подчиненный другогому населенному пункту (locality)
032 ············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор населенного пункта в соответствии со справочником РСХН
033 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор населенного пункта в соответствии со справочником РСХН
034 ·········</dt:subLocality>
035 ·········<dt:street> dt:Street [0..1] Улица
036 ············<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор улицы в соответствии со справочником РСХН
037 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор улицы в соответствии со справочником РСХН
038 ·········</dt:street>
039 ·········<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
040 ·········<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
041 ·········<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
042 ·········<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
043 ·········<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
044 ·········<dt:additionalInfo>?</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация
045 ·········<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
046 ······</dt:address>
047 ······<dt:activityList count="?" total="?" offset="?"> dt:EnterpriseActivityList [1..1] Виды деятельности площадки
048 ·········<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая площадкой
049 ············<dt:name>?</dt:name> bs:NText [1..1] Название вида деятельности
050 ·········</dt:activity>
051 ······</dt:activityList>
052 ······<dt:owner> dt:BusinessEntity [0..1] Хозяйствующий субъект-собственник площадки
053 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор хозяйствующего субъекта
054 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор хозяйствующего субъекта
055 ······</dt:owner>
056 ······<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе
057 ·········<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе
058 ············<dt:inn>?</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта
059 ·········</dt:businessEntity>
060 ·········<dt:kpp>?</dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП)
061 ······</dt:officialRegistration>
062 ······<dt:registryStatus>?</dt:registryStatus> dt:EnterpriseStatus [0..1]

(v2.1) Статус площадки в реестре ИС Цербер

  • UNVERIFIED - Не подтверджен (не в реестре)
  • VERIFIED - Подтвержден (включен в реестр)
  • CANCELED - Исключен из реестра
  • DELETED - Удален
063 ···</merc:enterprise>
064 </merc:modifyEnterpriseResponse>

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0

Источник — http://help.vetrf.ru/index.php?title=MercuryG2B:ModifyEnterprise:v3.0&oldid=40404