GetPurposeByUuid v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
(не показано 7 промежуточных версий этого же участника) | |||
Строка 29: | Строка 29: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getPurposeByUuidRequest>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|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;"| Идентификатор версии назначения груза. | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getPurposeByUuidRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} | |||
==Спецификация ответа== | |||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getPurposeByUuidResponse>'''}} | |||
| | | | ||
|style="font-family: Courier;" | | | | ||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}purpose>'''}} | |||
|[[Purpose_v2.0|dt:Purpose]] | |||
|[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;"| Статус версии назначения груза. | |||
|- | |||
|008 | |||
|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: | |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|bs:}}next>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}next>'''}} | |||
|[[UUID|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>'''}} | |||
|[[String255|bs:String255]] | |||
|[1..1] | |[1..1] | ||
| style="width:52em;"| Наименование назначения груза. | |||
|style=" | |||
|- | |- | ||
| | |013 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}purpose>'''}} | ||
| | |||
| | | | ||
| style="width:52em;"| | |||
|- | |||
|014 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getPurposeByUuidResponse>'''}} | |||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
|} | |} | ||
==Описание ошибок== | ==Описание ошибок== | ||
Строка 71: | Строка 169: | ||
==Пример запроса== | ==Пример запроса== | ||
<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:getPurposeByUuidRequest> | |||
<bs:uuid>fedc4b78-053c-11e1-99b4-d8d385fbc9e8</bs:uuid> | |||
</ws:getPurposeByUuidRequest> | |||
</soapenv:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> | ||
Строка 83: | Строка 188: | ||
<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:getPurposeByUuidResponse 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:purpose> | |||
<bs:uuid>fedc4b78-053c-11e1-99b4-d8d385fbc9e8</bs:uuid> | |||
<bs:guid>5b914721-e089-11e1-bcf3-b499babae7ea</bs:guid> | |||
<bs:active>true</bs:active> | |||
<bs:last>true</bs:last> | |||
<bs:status>100</bs:status> | |||
<bs:createDate>2009-04-23T10:47:55+04:00</bs:createDate> | |||
<bs:updateDate>2009-04-23T10:47:55+04:00</bs:updateDate> | |||
<dt:name>в корм рыбам</dt:name> | |||
</dt:purpose> | |||
</v2:getPurposeByUuidResponse> | |||
</soap:Body> | |||
</soapenv:Envelope> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</div> | </div> |
Текущая версия на 22:51, 10 октября 2020
Общие сведения
Операция GetPurposeByUuid предназначена для возвращения сведений о версии назначения груза по его уникальному идентификатору. В общем случае может быть возвращена не последняя и/или не актуальная запись (last=false, active=false). Выполнение операции заканчивается либо возвратом записи о назначении груза, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- уникальный идентификатор версии записи.
Выходные данные
- данные об указанном назначении груза.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getPurposeByUuidRequest> | |||
002 | ···<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии назначения груза. |
003 | </ws:getPurposeByUuidRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getPurposeByUuidResponse> | |||
002 | ···<dt:purpose> | dt:Purpose | [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 | ······<bs:next>UUID</bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи. |
012 | ······<dt:name>в корм животным</dt:name> | bs:String255 | [1..1] | Наименование назначения груза. |
013 | ···</dt:purpose> | |||
014 | </ws:getPurposeByUuidResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
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:getPurposeByUuidRequest>
<bs:uuid>fedc4b78-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
</ws:getPurposeByUuidRequest>
</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:getPurposeByUuidResponse 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:purpose>
<bs:uuid>fedc4b78-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>5b914721-e089-11e1-bcf3-b499babae7ea</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2009-04-23T10:47:55+04:00</bs:createDate>
<bs:updateDate>2009-04-23T10:47:55+04:00</bs:updateDate>
<dt:name>в корм рыбам</dt:name>
</dt:purpose>
</v2:getPurposeByUuidResponse>
</soap:Body>
</soapenv:Envelope>