Exportcenter:getUnitList:v2.3: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Новая страница: «==Общие сведения== Операция '''GetUnitList''' предназначена для получения списка актуальных зап...»)
 
 
Строка 58: Строка 58:
| style="width:52em;"|  
| style="width:52em;"|  
|-
|-
|}
== Спецификация ответа ==
{| class="wikitable"
! #
! Название XML-элемента
! Тип
! Обязат.
! Описание (нажмите [...] для отображения дополнительного описания)
|-
|001
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getUnitListResponse>'''}}
|
|
| style="width:52em;"|
|-
|002
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}unitList {{color|Red|total&#61;}}{{color|#007f15|"?"}} {{color|Red|offset&#61;}}{{color|#007f15|"?"}} {{color|Red|count&#61;}}{{color|#007f15|"?"}}>'''}}
|dt:UnitList
|[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;">
* total - всего записей
* offset - смещение относительно первого элемента
* count - количество выводимых записей
|-
|003
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}unit>'''}}
|dt:Unit
|[0..1]
|style="width:52em;" | Единица измерения
|-
|004
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}}
|bs:UUID
|[1..1]
|style="width:52em;" | Идентификатор версии единицы измерения
|-
|005
|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;" | Глобальный идентификатор единицы измерения
|-
|006
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}}
|xs:boolean
|[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;">
* true - запись активна
* false - запись не активна
</div>
</div>
|-
|007
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}}
|xs:boolean
|[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;">
* true - запись активна
* false - запись не активна
</div>
</div>
|-
|008
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}status>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}}
|bs:VersionStatus
|[1..1]
|style="width:52em;" | Статус версии единицы измерения
|-
|009
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}}
|xs:DateTime
|[1..1]
|style="width:52em;" | Дата создания единицы измерения
|-
|010
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}}
|xs:DateTime
|[1..1]
|style="width:52em;" | Дата изменения единицы измерения
|-
|011
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}}
|bs:UUID
|[0..1]
|style="width:52em;" | Идентификатор предыдущей версии записи реестра единиц измерения
|-
|012
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}}
|bs:String255
|[1..1]
|style="width:52em;" | Наименование единицы измерения
|-
|013
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullName>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fullName>'''}}
|bs:String255
|[1..1]
|style="width:52em;" | Полное наименование единицы измерения
|-
|-
|014
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}commonUnitGuid>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}commonUnitGuid>'''}}
|bs:UUID
|[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>
|-
|015
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|dt:}}factor>'''}}{{color|#131313|?}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}factor>'''}}
|xs:integer
|[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;">
* Например, для тонны = 1000
</div>
</div>
|-
|016
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}unit>'''}}
|
|
|
|-
|-
|017
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}unitList>'''}}
|
|
|
|-
|018
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</{{color|#660e7a|ws:}}getUnitListResponse>'''}}
|
|
|
|}
|}

Текущая версия на 05:58, 2 сентября 2024

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

Операция GetUnitList предназначена для получения списка актуальных записей о единицах измерения (active=true, last=true). Поддерживается постраничный вывод. Выполнение операции заканчивается либо возвратом списка единиц измерения, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getUnitListResponse>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
003 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000
004 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 </ws:getUnitListResponse>

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getUnitListResponse>
002 ···<dt:unitList total="?" offset="?" count="?"> dt:UnitList [1..1]

Список единиц измерения

  • total - всего записей
  • offset - смещение относительно первого элемента
  • count - количество выводимых записей
003 ······<dt:unit> dt:Unit [0..1] Единица измерения
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии единицы измерения
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор единицы измерения
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Является ли запись активной

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

Является ли версия записи последней

  • true - запись активна
  • false - запись не активна
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус версии единицы измерения
009 ·········<bs:createDate>?</bs:createDate> xs:DateTime [1..1] Дата создания единицы измерения
010 ·········<bs:updateDate>?</bs:updateDate> xs:DateTime [1..1] Дата изменения единицы измерения
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи реестра единиц измерения
012 ·········<dt:name>?</dt:name> bs:String255 [1..1] Наименование единицы измерения
013 ·········<dt:fullName>?</dt:fullName> bs:String255 [1..1] Полное наименование единицы измерения
014 ·········<dt:commonUnitGuid>?</dt:commonUnitGuid> bs:UUID [1..1]

Глобальный идентификатор базовой единицы измерения

  • Например, для тонны базовая единица - кг
015 ·········<dt:factor>?</dt:factor> xs:integer [1..1]

Коэффициент относительно базовой единицы измерения

  • Например, для тонны = 1000
016 ······</dt:unit>
017 ···</dt:unitList>
018 </ws:getUnitListResponse>
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:getUnitList:v2.3&oldid=40904