Herriot:ReplaceAnimalIdentity:v1.0: различия между версиями

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


== Спецификация запроса ==
== Спецификация запроса ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<hrt:replaceAnimalIdentityRequest>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:localTransactionId>'''}}{{color|#131313|?}}{{color|#190dbf|'''</hrt:localTransactionId>'''}}
|bs:Identifier
|[1..1]
| style="width:52em;"| Идентификатор заявки в клиентской системе
|-
|003
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:initiator>'''}}
|vd:User
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Пользователь, зарегистрированный в ВетИС, инициирующий запрос</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* является ответственным за выполнение бизнес-операции
* требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт</div>
</div>
|-
|004
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}login>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}login>'''}}
|xs:NCName
|[1..1]
| style="width:52em;"| Логин пользователя
|-
|005
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:initiator>'''}}
|
|
| style="width:52em;"|
|-
|006
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:referencedMarkingEvent>'''}}
|vd:AnimalMarkingEvent
|[1..1]
| style="width:52em;"| Сведения о замене средства маркирования
|-
|007
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}actualDate>'''}}
|bs:ComplexDatePeriod
|[1..1]
| style="width:52em;"| Дата замены средства маркирования
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}date>'''}}
|bs:ComplexDate
|[1..1]
| style="width:52em;"| Точное значение даты
|-
|009
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|[1..1]
| style="width:52em;"| Год
|-
|010
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|[1..1]
| style="width:52em;"| Месяц
|-
|011
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|[1..1]
| style="width:52em;"| День
|-
|012
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|bs:}}date>'''}}
|
|
| style="width:52em;"|
|-
|013
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}actualDate>'''}}
|
|
| style="width:52em;"|
|-
|014
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}operatorBusinessEntity>'''}}
|dt:BusinessEntity
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Сведения о физическом лице / организации, осуществлявшем мероприятие</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Должно быть передано одно из значений: guid или inn
* Cправочник [[Herriot:Services:v1.0#EnterpriseService_.28.D1.80.D0.B5.D0.B5.D1.81.D1.82.D1.80_.D1.85.D0.BE.D0.B7.D1.8F.D0.B9.D1.81.D1.82.D0.B2.D1.83.D1.8E.D1.89.D0.B8.D1.85_.D1.81.D1.83.D0.B1.D1.8A.D0.B5.D0.BA.D1.82.D0.BE.D0.B2_.D0.B8_.D0.BF.D1.80.D0.B5.D0.B4.D0.BF.D1.80.D0.B8.D1.8F.D1.82.D0.B8.D0.B9.29|ES.HRT.1. Реестр хозяйствующих субъектов]]</div>
</div>
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[0..1]
| style="width:52em;"| Глобальный идентификатор записи
|-
|016
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}inn>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}inn>'''}}
|bs:String255
|[0..1]
| style="width:52em;"| ИНН
|-
|017
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}operatorBusinessEntity>'''}}
|
|
| style="width:52em;"|
|-
|018
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}occurrenceReason>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|vd:}}occurrenceReason>'''}}
|vd:AnimalMarkingEventReason
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Причина замены средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Возможные значения:
** LOSS - Средство маркирования утеряно
** BROKEN - Средство маркирования повреждено (сломано)
** EXPIRATION - Истёк срок действия средства маркирования</div>
</div>
|-
|019
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|vd:}}associatedAnimalIdentity>'''}}
|vd:AnimalIdentity
|[1..1]
| style="width:52em;"| Сведения о новой маркировке животного / группы животных
|-
|020
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|vd:}}attachedLabel>'''}}
|dt:AnimalLabel
|[1..1]
| style="width:52em;"| Сведения о маркировке
|-
|021
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}animalID format&#61;{{color|#007f15|"?"}}>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}animalID>'''}}
|dt:AnimalID
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Номер, нанесенный на животное с помощью средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Возможные значения атрибута '''format''':
** UNMM - Формат Уникального номера средства маркирования (УНСМ) в соответствии с утвержденными Правилами маркирования животных РСХН
** OTHER - Другой тип номера ('''значение по умолчанию, если не передано в запросе''')
* Номер '''animalID''' обязателен для следующих типов средства маркирования:
** LABEL - Бирка
** MICROCHIP - Вживляемый микрочип
** BOLUS - Болюс
** RING - Кольцо
** ELECTRONIC_RING - Электронное кольцо
** COLLAR - Ошейник
** ELECTRONIC_COLAR - Электронный ошейник
** WING_TAG - Крыло-метка
** ELECTRONIC_WING_TAG - Электронное крыло-метка
** ELECTRONIC_TAG - Электронная метка
** NAMEPLATE - Табло</div>
</div>
|-
|022
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}markingMeans>'''}}
|dt:AnimalMarkingMeans
|[1..1]
| style="width:52em;"| Cредство маркирования
|-
|023
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|dt:}}type>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}type>'''}}
|dt:AnimalMarkingMeansType
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Тип средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
Возможные значения:
* LABEL - Бирка
* MICROCHIP - Вживляемый микрочип
* BRAND - Тавро/Клеймо
* TATTOO - Татуировка
* BOLUS - Болюс
* RING - Кольцо
* ELECTRONIC_RING - Электронное кольцо
* COLLAR - Ошейник
* ELECTRONIC_COLAR - Электронный ошейник
* WING_TAG - Крыло-метка
* ELECTRONIC_WING_TAG - Электронное крыло-метка
* ELECTRONIC_TAG - Электронная метка
* TISSUE_SECTION - Вырез тканей
* NAMEPLATE - Табло</div>
</div>
|-
|024
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}markingMeans>'''}}
|
|
| style="width:52em;"|
|-
|025
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}attachmentDate>'''}}
|bs:ComplexDate
|[1..1]
| style="width:52em;"| Дата маркирования животного
|-
|026
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}year>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}year>'''}}
|bs:Year
|[1..1]
| style="width:52em;"| Год
|-
|027
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}month>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}month>'''}}
|bs:Month
|[1..1]
| style="width:52em;"| Месяц
|-
|028
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}day>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}day>'''}}
|bs:Day
|[0..1]
| style="width:52em;"| День
|-
|029
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}attachmentDate>'''}}
|
|
| style="width:52em;"|
|-
|030
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}attachmentLocation>'''}}
|dt:AnimalMarkingLocation
|[1..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Место нанесения/прикрепления средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* справочник [[Herriot:Services:v1.0#DictionaryService_.28.D1.80.D0.B5.D0.B5.D1.81.D1.82.D1.80_.D1.81.D0.BF.D1.80.D0.B0.D0.B2.D0.BE.D1.87.D0.BD.D0.BE.D0.B9_.D0.B8.D0.BD.D1.84.D0.BE.D1.80.D0.BC.D0.B0.D1.86.D0.B8.D0.B8.29|DS.HRT.5. Места нанесения средств маркирования]]</div>
</div>
|-
|031
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор записи
|-
|032
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}attachmentLocation>'''}}
|
|
| style="width:52em;"|
|-
|033
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}description>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}description>'''}}
|bs:String255
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Описание средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Обязательно для следующих типов средства маркирования:
** BRAND (Тавро/Клеймо)
** TATTOO (Татуировка)
** TISSUE_SECTION - Вырез тканей</div>
</div>
|-
|034
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''<{{color|#660e7a|dt:}}photo>'''}}
|bs:File
|[0..1]
|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
<span style="white-space:nowrap; font-weight: normal;">Фото средства маркирования</span>
<div class="mw-collapsible-content" style="font-weight: normal;">
* Обязательно для следующих типов средства маркирования:
** BRAND (Тавро/Клеймо)
** TATTOO (Татуировка)
** TISSUE_SECTION - Вырез тканей</div>
</div>
|-
|035
|style="font-weight: ; font-family: Courier;" |···············{{color|#190dbf|'''<{{color|#660e7a|bs:}}id>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}id>'''}}
|bs:Identifier
|[1..1]
| style="width:52em;"| Идентификатор загруженного файла
|-
|036
|style="font-weight: ; font-family: Courier;" |············{{color|#190dbf|'''</{{color|#660e7a|dt:}}photo>'''}}
|
|
| style="width:52em;"|
|-
|037
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''</{{color|#660e7a|vd:}}attachedLabel>'''}}
|
|
| style="width:52em;"|
|-
|038
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|vd:}}associatedAnimalIdentity>'''}}
|
|
| style="width:52em;"|
|-
|039
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:referencedMarkingEvent>'''}}
|
|
| style="width:52em;"|
|-
|040
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<hrt:animalIdentityRef>'''}}
|vd:AnimalIdentity
|[1..1]
| style="width:52em;"| Сведения о заменяемом средстве маркирования
|-
|041
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}}
|bs:UUID
|[1..1]
| style="width:52em;"| Глобальный идентификатор средства маркирования
|-
|042
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</hrt:animalIdentityRef>'''}}
|
|
| style="width:52em;"|
|-
|043
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</hrt:replaceAnimalIdentityRequest>'''}}
|
|
| style="width:52em;"|
|-
|}


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

Текущая версия на 01:16, 21 марта 2024

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

Код Описание операции
AMS.HRT.2.3 Операция предназначена для перерегистрации сведений об идентификации зарегистрированного животного или группы животных (замены средства маркирования)

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

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

Пользователь, зарегистрированный в ВетИС, инициирующий запрос

  • является ответственным за выполнение бизнес-операции
  • требуется логин ветврача или пользователя ХС, логин для базовой аутентификации не подойдёт
004 ······<vd:login>?</vd:login> xs:NCName [1..1] Логин пользователя
005 ···</hrt:initiator>
006 ···<hrt:referencedMarkingEvent> vd:AnimalMarkingEvent [1..1] Сведения о замене средства маркирования
007 ······<vd:actualDate> bs:ComplexDatePeriod [1..1] Дата замены средства маркирования
008 ·········<bs:date> bs:ComplexDate [1..1] Точное значение даты
009 ············<bs:year>?</bs:year> bs:Year [1..1] Год
010 ············<bs:month>?</bs:month> bs:Month [1..1] Месяц
011 ············<bs:day>?</bs:day> bs:Day [1..1] День
012 ·········</bs:date>
013 ······</vd:actualDate>
014 ······<vd:operatorBusinessEntity> dt:BusinessEntity [0..1]

Сведения о физическом лице / организации, осуществлявшем мероприятие

015 ·········<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
016 ·········<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН
017 ······</vd:operatorBusinessEntity>
018 ······<vd:occurrenceReason>?</vd:occurrenceReason> vd:AnimalMarkingEventReason [0..1]

Причина замены средства маркирования

  • Возможные значения:
    • LOSS - Средство маркирования утеряно
    • BROKEN - Средство маркирования повреждено (сломано)
    • EXPIRATION - Истёк срок действия средства маркирования
019 ······<vd:associatedAnimalIdentity> vd:AnimalIdentity [1..1] Сведения о новой маркировке животного / группы животных
020 ·········<vd:attachedLabel> dt:AnimalLabel [1..1] Сведения о маркировке
021 ············<dt:animalID format="?">?</dt:animalID> dt:AnimalID [0..1]

Номер, нанесенный на животное с помощью средства маркирования

  • Возможные значения атрибута format:
    • UNMM - Формат Уникального номера средства маркирования (УНСМ) в соответствии с утвержденными Правилами маркирования животных РСХН
    • OTHER - Другой тип номера (значение по умолчанию, если не передано в запросе)
  • Номер animalID обязателен для следующих типов средства маркирования:
    • LABEL - Бирка
    • MICROCHIP - Вживляемый микрочип
    • BOLUS - Болюс
    • RING - Кольцо
    • ELECTRONIC_RING - Электронное кольцо
    • COLLAR - Ошейник
    • ELECTRONIC_COLAR - Электронный ошейник
    • WING_TAG - Крыло-метка
    • ELECTRONIC_WING_TAG - Электронное крыло-метка
    • ELECTRONIC_TAG - Электронная метка
    • NAMEPLATE - Табло
022 ············<dt:markingMeans> dt:AnimalMarkingMeans [1..1] Cредство маркирования
023 ···············<dt:type>?</dt:type> dt:AnimalMarkingMeansType [1..1]

Тип средства маркирования

Возможные значения:

  • LABEL - Бирка
  • MICROCHIP - Вживляемый микрочип
  • BRAND - Тавро/Клеймо
  • TATTOO - Татуировка
  • BOLUS - Болюс
  • RING - Кольцо
  • ELECTRONIC_RING - Электронное кольцо
  • COLLAR - Ошейник
  • ELECTRONIC_COLAR - Электронный ошейник
  • WING_TAG - Крыло-метка
  • ELECTRONIC_WING_TAG - Электронное крыло-метка
  • ELECTRONIC_TAG - Электронная метка
  • TISSUE_SECTION - Вырез тканей
  • NAMEPLATE - Табло
024 ············</dt:markingMeans>
025 ············<dt:attachmentDate> bs:ComplexDate [1..1] Дата маркирования животного
026 ···············<bs:year>?</bs:year> bs:Year [1..1] Год
027 ···············<bs:month>?</bs:month> bs:Month [1..1] Месяц
028 ···············<bs:day>?</bs:day> bs:Day [0..1] День
029 ············</dt:attachmentDate>
030 ············<dt:attachmentLocation> dt:AnimalMarkingLocation [1..1]

Место нанесения/прикрепления средства маркирования

031 ···············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
032 ············</dt:attachmentLocation>
033 ············<dt:description>?</dt:description> bs:String255 [0..1]

Описание средства маркирования

  • Обязательно для следующих типов средства маркирования:
    • BRAND (Тавро/Клеймо)
    • TATTOO (Татуировка)
    • TISSUE_SECTION - Вырез тканей
034 ············<dt:photo> bs:File [0..1]

Фото средства маркирования

  • Обязательно для следующих типов средства маркирования:
    • BRAND (Тавро/Клеймо)
    • TATTOO (Татуировка)
    • TISSUE_SECTION - Вырез тканей
035 ···············<bs:id>?</bs:id> bs:Identifier [1..1] Идентификатор загруженного файла
036 ············</dt:photo>
037 ·········</vd:attachedLabel>
038 ······</vd:associatedAnimalIdentity>
039 ···</hrt:referencedMarkingEvent>
040 ···<hrt:animalIdentityRef> vd:AnimalIdentity [1..1] Сведения о заменяемом средстве маркирования
041 ······<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор средства маркирования
042 ···</hrt:animalIdentityRef>
043 </hrt:replaceAnimalIdentityRequest>

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

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

TODO

См. также

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

Источник — http://help.vetrf.ru/index.php?title=Herriot:ReplaceAnimalIdentity:v1.0&oldid=39364