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-элемента | Тип | Обязат. | Описание | Пример |
|---|---|---|---|---|---|
| 1 | <ws:getPurposeByGuidResponse> | ||||
| 2 | ···<dt:purpose> | dt:Purpose | [1..1] | Назначение груза | |
| 3 | ······<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии назначения груза | <bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid> |
| 4 | ······<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор назначения груза | <bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid> |
| 5 | ······<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
| 6 | ······<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
| 7 | ······<bs:status> | bs:VersionStatus | [1..1] | Статус версии назначения груза | <bs:status>100</bs:status> |
| 8 | ······<bs:createDate> | xs:DateTime | [1..1] | Дата создания назначения груза | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
| 9 | ······<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения назначения груза. | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
| 10 | ······<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
| 11 | ······<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
| 12 | ······<dt:name> | bs:String255 | [1..1] | Наименование назначения груза | <dt:name>в корм животным</dt:name> |
| 13 | ···</dt:purpose> | ||||
| 14 | </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>
