Exportcenter:GetPurposeChangesList:v2.1: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 20: | Строка 20: | ||
==Спецификация запроса== | ==Спецификация запроса== | ||
{| class="wikitable" | |||
! # | |||
! Название XML-элемента | |||
! Тип | |||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
|- | |||
|001 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getPurposeChangesListRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}} | |||
|[[ListOptions|bs:ListOptions]] | |||
|[0..1] | |||
| style="width:52em;"| Параметры запрашиваемого списка. | |||
|- | |||
|003 | |||
|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] | |||
|[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; | |||
* Максимально возможное значение 1000.</div> | |||
</div> | |||
|- | |||
|004 | |||
|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] | |||
|[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: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|006 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDateInterval>'''}} | |||
|[[DataInterval|bs:DataInterval]] | |||
|[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> | |||
|- | |||
|007 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}beginDate>'''}}{{color|#131313|2017-07-07T00:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}beginDate>'''}} | |||
|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] | |||
|[1..1] | |||
| style="width:52em;"| Начало временного интервала. | |||
|- | |||
|008 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}endDate>'''}}{{color|#131313|2017-07-25T00:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}endDate>'''}} | |||
|[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:}}updateDateInterval>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|010 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getPurposeChangesListRequest>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} | |||
==Спецификация ответа== | ==Спецификация ответа== | ||
{| class="wikitable" | |||
== | ! # | ||
! Название XML-элемента | |||
== | ! Тип | ||
! Обязат. | |||
! Описание (нажмите [...] для отображения дополнительного описания) | |||
[[ | |- | ||
[[ | |001 | ||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getPurposeChangesListResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|002 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|dt:}}purposeList {{color|Red|total=}}{{color|#007f15|"2"}} {{color|Red|offset=}}{{color|#007f15|"0"}} {{color|Red|count=}}{{color|#007f15|"2"}}>'''}} | |||
|[[PurposeList_v2.0|dt:PurposeList]] | |||
|[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;"> | |||
* total - всего записей; | |||
* offset - смещение относительно первого элемента; | |||
* count - количество выводимых записей.</div> | |||
</div> | |||
|- | |||
|003 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|dt:}}purpose>'''}} | |||
|[[Purpose_v2.0|dt:Purpose]] | |||
|[0..*] | |||
| style="width:52em;"| Назначение груза. | |||
|- | |||
|004 | |||
|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;"| Идентификатор версии назначения груза. | |||
|- | |||
|005 | |||
|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;"| Глобальный идентификатор назначения груза. | |||
|- | |||
|006 | |||
|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> | |||
|- | |||
|007 | |||
|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> | |||
|- | |||
|008 | |||
|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;"| Статус версии назначения груза. | |||
|- | |||
|009 | |||
|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;"| Дата создания назначения груза. | |||
|- | |||
|010 | |||
|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;"| Дата изменения назначения груза. | |||
|- | |||
|011 | |||
|style="font-weight: ; font-family: Courier;" |·········{{color|#190dbf|'''<{{color|#660e7a|bs:}}previous>'''}}{{color|#131313|UUID}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}previous>'''}} | |||
|[[UUID|bs:UUID]] | |||
|[0..1] | |||
| style="width:52em;"| Идентификатор предыдущей версии записи. | |||
|- | |||
|012 | |||
|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;"| Идентификатор следующей версии записи. | |||
|- | |||
|013 | |||
|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;"| Наименование назначения груза. | |||
|- | |||
|014 | |||
|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''</{{color|#660e7a|dt:}}purpose>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|015 | |||
|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|dt:}}purposeList>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|016 | |||
|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getPurposeChangesListResponse>'''}} | |||
| | |||
| | |||
| style="width:52em;"| | |||
|- | |||
|} |
Текущая версия на 16:28, 18 мая 2022
Общие сведения
Операция GetPurposeChangesList предназначена для получения списка целей, изменённых в указанный период времени. В общем случае в список могут попасть не актуальные и/или не последние записи (active=false, last=false). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
Используемые пространства имён
Пространство имён (xmlns) | XSD-схема, содержащая описание типов |
---|---|
xmlns:bs="http://api.vetrf.ru/schema/cdm/base" | https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/base_v2.0.xsd |
xmlns:ws="http://api.vetrf.ru/schema/cdm/registry/ws-definitions/v2" | https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/registry_ws_definitions_v2.2.xsd |
xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" | https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/dictionary_v2.2.xsd |
Спецификация запроса
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getPurposeChangesListRequest> | |||
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 | ···<bs:updateDateInterval> | bs:DataInterval | [1..1] | Интервал времени обновления.
|
007 | ······<bs:beginDate>2017-07-07T00:00:00</bs:beginDate> | xs:dateTime | [1..1] | Начало временного интервала. |
008 | ······<bs:endDate>2017-07-25T00:00:00</bs:endDate> | xs:dateTime | [1..1] | Конец временного интервала. |
009 | ···</bs:updateDateInterval> | |||
010 | </ws:getPurposeChangesListRequest> |
Спецификация ответа
# | Название XML-элемента | Тип | Обязат. | Описание (нажмите [...] для отображения дополнительного описания) |
---|---|---|---|---|
001 | <ws:getPurposeChangesListResponse> | |||
002 | ···<dt:purposeList total="2" offset="0" count="2"> | dt:PurposeList | [1..1] | Список назначений груза.
|
003 | ······<dt:purpose> | dt:Purpose | [0..*] | Назначение груза. |
004 | ·········<bs:uuid>UUID</bs:uuid> | bs:UUID | [1..1] | Идентификатор версии назначения груза. |
005 | ·········<bs:guid>GUID</bs:guid> | bs:UUID | [1..1] | Глобальный идентификатор назначения груза. |
006 | ·········<bs:active>true</bs:active> | xs:boolean | [1..1] | Описывает, является ли запись активной.
|
007 | ·········<bs:last>true</bs:last> | xs:boolean | [1..1] | Описывает, является ли версия записи последней.
|
008 | ·········<bs:status>100</bs:status> | bs:VersionStatus | [1..1] | Статус версии назначения груза. |
009 | ·········<bs:createDate>2017-07-07T12:00:00</bs:createDate> | xs:DateTime | [1..1] | Дата создания назначения груза. |
010 | ·········<bs:updateDate>2017-07-07T12:00:00</bs:updateDate> | xs:DateTime | [1..1] | Дата изменения назначения груза. |
011 | ·········<bs:previous>UUID</bs:previous> | bs:UUID | [0..1] | Идентификатор предыдущей версии записи. |
012 | ·········<bs:next>UUID</bs:next> | bs:UUID | [0..1] | Идентификатор следующей версии записи. |
013 | ·········<dt:name>в корм животным</dt:name> | bs:String255 | [1..1] | Наименование назначения груза. |
014 | ······</dt:purpose> | |||
015 | ···</dt:purposeList> | |||
016 | </ws:getPurposeChangesListResponse> |