GetPurposeByGuid v2.0
Перейти к навигации
Перейти к поиску
Общие сведения
Операция GetPurposeByGuid предназначена для поиска сведений о назначении груза по глобальному идентификатору. Возвращается последняя актуальная запись о назначении (last=true, active=true). Выполнение операции заканчивается либо возвратом записи о назначении груза, либо ошибкой, в случае если параметры запроса не корректны, если запись по запросу не найдена или произошла иная ошибка выполнения запроса.
Входные данные
- глобальный уникальный идентификатор назначения груза.
Выходные данные
- данные о назначении груза.
Спецификация запроса
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getPurposeByGuidRequest> | |||
| 002 | ···<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор назначения груза. |
| 003 | </ws:getPurposeByGuidRequest> |
Спецификация ответа
| # | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
|---|---|---|---|---|
| 001 | <ws:getPurposeByGuidResponse> | |||
| 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 | ······<dt:name>в корм животным</dt:name> | bs:String255 | [1..1] | Наименование назначения груза. |
| 012 | ···</dt:purpose> | |||
| 013 | </ws:getPurposeByGuidResponse> |
Описание ошибок
| Ошибка | Описание |
|---|---|
| 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:getPurposeByGuidRequest>
<bs:guid>5b914721-e089-11e1-bcf3-b499babae7ea</bs:guid>
</ws:getPurposeByGuidRequest>
</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:getPurposeByGuidResponse 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:getPurposeByGuidResponse>
</soap:Body>
</soapenv:Envelope>
