GetPurposeList v2.0: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 30: | Строка 30: | ||
! Тип | ! Тип | ||
! Обязат. | ! Обязат. | ||
! Описание | ! Описание (нажмите [...] для отображения дополнительного описания) | ||
|- | |- | ||
| | |001 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getPurposeListRequest>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |002 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}} | ||
|[[ListOptions|bs:ListOptions]] | |[[ListOptions|bs:ListOptions]] | ||
|[0..1] | |[0..1] | ||
| style="width:52em;"| Параметры запрашиваемого списка. | |||
|style=" | |||
|- | |- | ||
| | |003 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | ||
|[0..1] | |[0..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;"> | |||
* По умолчанию значение 100; | * По умолчанию значение 100; | ||
* Максимально возможное значение 1000. | * Максимально возможное значение 1000.</div> | ||
</div> | |||
|- | |- | ||
| | |004 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}} | ||
|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | |[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] | ||
|[0..1] | |[0..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;"> | |||
* По умолчанию значение 0.</div> | |||
</div> | |||
|- | |- | ||
| | |005 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}} | ||
| | | | ||
| | | | ||
| style="width:52em;"| | |||
|style=" | |||
|- | |- | ||
| | |006 | ||
|style="font-weight: | |style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getPurposeListRequest>'''}} | ||
| | | | ||
| | | | ||
|style=" | | style="width:52em;"| | ||
|- | |- | ||
|} | |} |
Версия 23:03, 10 октября 2020
Общие сведения
Операция GetPurposeList предназначена для получения списка актуальных записей о назначениях груза (active=true, last=true). Операция поддерживает постраничный вывод. Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Входные данные
- параметры выводимого списка.
Выходные данные
- список актуальных записей назначений груза.
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getPurposeListRequest> | |||
002 | ···<bs:listOptions> | bs:ListOptions | [0..1] | Параметры запрашиваемого списка. |
003 | ······<bs:count>10</bs:count> | xs:nonNegativeInteger | [0..1] | Максимальное запрашиваемое количество объектов в списке.
|
004 | ······<bs:offset>2</bs:offset> | xs:nonNegativeInteger | [0..1] | Номер элемента, по которому осуществляется смещение первого элемента списка.
|
005 | ···</bs:listOptions> | |||
006 | </ws:getPurposeListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание | Пример |
---|---|---|---|---|---|
1 | <ws:getPurposeListResponse> | ||||
2 | ···<dt:purposeList count="100" total="115" offset="0"> | dt:PurposeList | [1..1] | Список назначений груза
|
|
3 | ······<dt:purpose> | dt:Purpose | [0..*] | Назначение груза | |
4 | ·········<bs:uuid> | bs:UUID | [1..1] | Идентификатор версии назначения груза | <bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid> |
5 | ·········<bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор назначения груза | <bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid> |
6 | ·········<bs:active> | xs:boolean | [1..1] | Является ли запись активной:
|
<bs:active>true</bs:active> |
7 | ·········<bs:last> | xs:boolean | [1..1] | Является ли версия записи последней:
|
<bs:last>true</bs:last> |
8 | ·········<bs:status> | bs:VersionStatus | [1..1] | Статус версии назначения груза | <bs:status>100</bs:status> |
9 | ·········<bs:createDate> | xs:DateTime | [1..1] | Дата создания назначения груза | <bs:createDate>2017-07-07T12:00:00</bs:createDate> |
10 | ·········<bs:updateDate> | xs:DateTime | [1..1] | Дата изменения назначения груза | <bs:updateDate>2017-07-07T12:00:00</bs:updateDate> |
11 | ·········<bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи | <bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous> |
12 | ·········<bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи | <bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next> |
13 | ·········<dt:name> | bs:String255 | [1..1] | Наименование назначения груза | <dt:name>в корм животным</dt:name> |
14 | ······</dt:purpose> | ||||
15 | ···</dt:purposeList> | ||||
16 | </ws:getPurposeListResponse> |
Описание ошибок
Ошибка | Описание |
---|---|
InternalServiceFault | Внутренняя ошибка сервиса. |
IncorrectRequestFault | Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd. |
OffsetOutOfRangeFault | Заданный в запросе отступ больше числа записей в результате запроса. |
Пример запроса
Запрос первых трех назначений груза без смещения.
<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:getPurposeListRequest>
<bs:listOptions>
<bs:count>3</bs:count>
<bs:offset>0</bs:offset>
</bs:listOptions>
</ws:getPurposeListRequest>
</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:getPurposeListResponse 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:purposeList count="3" total="210" offset="0">
<dt:purpose>
<bs:uuid>fedc91a0-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>5b914aea-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-24T15:13:08+04:00</bs:createDate>
<bs:updateDate>2009-04-24T15:13:08+04:00</bs:updateDate>
<dt:name>адсорбация микотоксинов в кормах для с/х животных, в том числе птиц</dt:name>
</dt:purpose>
<dt:purpose>
<bs:uuid>fedc99e8-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>5b915b5e-e089-11e1-bcf3-b499babae7ea</bs:guid>
<bs:active>true</bs:active>
<bs:last>true</bs:last>
<bs:status>100</bs:status>
<bs:createDate>2009-05-21T15:26:10+04:00</bs:createDate>
<bs:updateDate>2009-05-21T15:26:10+04:00</bs:updateDate>
<dt:name>адсорбция афлатоксина В1 и предотвращение развития плесени в кормах для свиней и с/х птицы</dt:name>
</dt:purpose>
<dt:purpose>
<bs:uuid>fedc43a8-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
<bs:guid>5b913ae4-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-15T16:50:49+04:00</bs:createDate>
<bs:updateDate>2009-04-15T16:50:49+04:00</bs:updateDate>
<dt:name>аукцион</dt:name>
</dt:purpose>
</dt:purposeList>
</v2:getPurposeListResponse>
</soap:Body>
</soapenv:Envelope>