GetUnitByGuid v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(не показаны 4 промежуточные версии этого же участника) | |||
Строка 29: | Строка 29: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getUnitByGuidRequest>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор единицы измерения. | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getUnitByGuidRequest>'''}} | |||
| | | | ||
|style="font-family: Courier;" | | | | ||
| style="width:52em;"| | |||
|- | |||
|} | |||
==Спецификация ответа== | |||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getUnitByGuidResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}unit>'''}} | |||
|[[Unit_v2.0|dt:Unit]] | |||
|[1..1] | |||
| style="width:52em;"| Единица измерения. | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}uuid>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}uuid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Идентификатор версии единицы измерения. | |||
|- | |||
|004 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}guid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}guid>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
| style="width:52em;"| Глобальный идентификатор единицы измерения. | |||
|- | |||
|005 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}active>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}active>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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> | |||
|- | |||
|006 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}last>'''}}{{color|#131313|true}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}last>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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:}}status>'''}}{{color|#131313|100}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}status>'''}} | |||
|[[VersionStatus|bs:VersionStatus]] | |||
|[1..1] | |||
| style="width:52em;"| .Статус версии единицы измерения. | |||
|- | |- | ||
|2 | |008 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}createDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}createDate>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
| style="width:52em;"| Дата создания единицы измерения. | |||
|- | |||
|009 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDate>'''}}{{color|#131313|2017-07-07T12:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDate>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime] | |||
|[1..1] | |||
| style="width:52em;"| Дата изменения единицы измерения. | |||
|- | |||
|010 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}} | |||
|[[UUID|bs:UUID]] | |[[UUID|bs:UUID]] | ||
|[0..1] | |||
| style="width:52em;"| Идентификатор предыдущей версии записи реестра единиц измерения. | |||
|- | |||
|011 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}name>'''}}{{color|#131313|кг}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}name>'''}} | |||
|[[String255|bs:String255]] | |||
|[1..1] | |||
| style="width:52em;"| Наименование единицы измерения. | |||
|- | |||
|012 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}fullName>'''}}{{color|#131313|килограмм}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}fullName>'''}} | |||
|[[String255|bs:String255]] | |||
|[1..1] | |[1..1] | ||
| style="width:52em;"| Полное наименование единицы измерения. | |||
|style=" | |||
|- | |- | ||
| | |013 | ||
|style="font-weight: bold; font-family: Courier;" |</ | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}commonUnitGuid>'''}}{{color|#131313|GUID}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}commonUnitGuid>'''}} | ||
|[[UUID|bs:UUID]] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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> | |||
|- | |||
|014 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}factor>'''}}{{color|#131313|1}}{{color|#190dbf|'''</{{color|#660e7a|dt:}}factor>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#Integer xs:integer] | |||
|[1..1] | |||
|<div class="mw-collapsible mw-collapsed" data-expandtext=" ... " 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> | |||
|- | |||
|015 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}unit>'''}} | |||
| | | | ||
| | |||
| style="width:52em;"| | |||
|- | |||
|016 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getUnitByGuidResponse>'''}} | |||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
|} | |} | ||
==Описание ошибок== | ==Описание ошибок== | ||
Строка 71: | Строка 193: | ||
==Пример запроса== | ==Пример запроса== | ||
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:100%"> | ||
Запрос | Запрос единицы измерения по глобальному идентификатору. | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base"> | |||
<soapenv:Header/> | |||
<soapenv:Body> | |||
<ws:getUnitByGuidRequest> | |||
<bs:guid>52082c55-8628-409f-818c-80a02632c09f</bs:guid> | |||
</ws:getUnitByGuidRequest> | |||
</soapenv:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
Строка 83: | Строка 212: | ||
<div class = "mw-collapsible-content"> | <div class = "mw-collapsible-content"> | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> | |||
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> | |||
<v2:getUnitByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2"> | |||
<dt:unit> | |||
<bs:uuid>069796f6-053d-11e1-99b4-d8d385fbc9e8</bs:uuid> | |||
<bs:guid>52082c55-8628-409f-818c-80a02632c09f</bs:guid> | |||
<bs:active>true</bs:active> | |||
<bs:last>true</bs:last> | |||
<bs:status>100</bs:status> | |||
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate> | |||
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate> | |||
<dt:name>бочка</dt:name> | |||
<dt:fullName>бочка</dt:fullName> | |||
<dt:commonUnitGuid>52082c55-8628-409f-818c-80a02632c09f</dt:commonUnitGuid> | |||
<dt:factor>1</dt:factor> | |||
</dt:unit> | |||
</v2:getUnitByGuidResponse> | |||
</soap:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
</div> | </div> | ||
<br /> | |||
[[Category:Ветис.API]] | [[Category:Ветис.API]] | ||
[[Category:DictionaryService]] | [[Category:DictionaryService]] |
Текущая версия на 23:29, 10 октября 2020
Общие сведения
Операция GetUnitByGuid предназначена для получения данных о единице измерения по её глобальному идентификатору. Возвращается последняя актуальная запись (active=true, last=true). Выполнение операции заканчивается либо возвратом записи единицы измерения, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- глобальный идентификатор единицы измерения.
Выходные данные
- данные о единице измерения с указанным идентификатором.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getUnitByGuidRequest> | |||
002 | ···<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор единицы измерения. |
003 | </ws:getUnitByGuidRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getUnitByGuidResponse> | |||
002 | ···<dt:unit> | dt:Unit | [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>100</bs:status> | bs:VersionStatus | [1..1] | .Статус версии единицы измерения. |
008 | ······<bs:createDate>2017-07-07T12:00:00</bs:createDate> | xs:DateTime | [1..1] | Дата создания единицы измерения. |
009 | ······<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | xs:DateTime | [1..1] | Дата изменения единицы измерения. |
010 | ······<bs:previous>UUID</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи реестра единиц измерения. |
011 | ······<dt:name>кг</dt:name> | bs:String255 | [1..1] | Наименование единицы измерения. |
012 | ······<dt:fullName>килограмм</dt:fullName> | bs:String255 | [1..1] | Полное наименование единицы измерения. |
013 | ······<dt:commonUnitGuid>GUID</dt:commonUnitGuid> | bs:UUID | [1..1] | Глобальный идентификатор базовой единицы измерения.
|
014 | ······<dt:factor>1</dt:factor> | xs:integer | [1..1] | Коэффициент относительно базовой единицы измерения.
|
015 | ···</dt:unit> | |||
016 | </ws:getUnitByGuidResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
EntityNotFoundFault | Объект с заданными параметрами не найден в базе. |
Пример запроса
Запрос единицы измерения по глобальному идентификатору.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" xmlns:bs="http://api.vetrf.ru/schema/cdm/base">
<soapenv:Header/>
<soapenv:Body>
<ws:getUnitByGuidRequest>
<bs:guid>52082c55-8628-409f-818c-80a02632c09f</bs:guid>
</ws:getUnitByGuidRequest>
</soapenv:Body>
</soapenv:Envelope>
Ответ на запрос.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<v2:getUnitByGuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" xmlns:v2="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2">
<dt:unit>
<bs:uuid>069796f6-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>52082c55-8628-409f-818c-80a02632c09f</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2008-01-01T00:00:00+03:00</bs:createDate>
<bs:updateDate>2008-01-01T00:00:00+03:00</bs:updateDate>
<dt:name>бочка</dt:name>
<dt:fullName>бочка</dt:fullName>
<dt:commonUnitGuid>52082c55-8628-409f-818c-80a02632c09f</dt:commonUnitGuid>
<dt:factor>1</dt:factor>
</dt:unit>
</v2:getUnitByGuidResponse>
</soap:Body>
</soapenv:Envelope>