GetPurposeList v2.0 - История изменений

Romanov-av: /* Спецификация ответа */

2020-10-10T20:11:29Z

Спецификация ответа

Romanov-av: /* Спецификация запроса */

2020-10-10T20:03:14Z

Спецификация запроса

← Предыдущая версия		Версия от 20:03, 10 октября 2020
Строка 30:		Строка 30:
	! Тип		! Тип
	! Обязат.		! Обязат.
	! Описание		! Описание (нажмите [...] для отображения дополнительного описания)
	~~! Пример~~
	\|-		\|-
	\|1		\|001
	\|style="font-weight: ~~bold~~; font-family: Courier;" \|<ws:getPurposeListRequest>		\|style="font-weight: ; font-family: Courier;" \|{{color\|#190dbf\|'''<ws:getPurposeListRequest>'''}}
	\|		\|
	\|		\|
	\|		\| style="width:52em;"\|
	\|style="~~font-family~~: ~~Courier~~;" \|
	\|-		\|-
	\|2		\|002
	\|style="font-weight: ~~bold~~; font-family: Courier;" \|···<bs:listOptions>		\|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="~~font-family~~: ~~Courier~~;" \|
	\|-		\|-
	\|3		\|003
	\|style="font-weight: ~~bold~~; font-family: Courier;" \|······<bs:count>		\|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>
	~~\|style="font-family: Courier;" \|~~<~~bs:count~~>10</~~bs:count~~>		</div>
	\|-		\|-
	\|4		\|004
	\|style="font-weight: ~~bold~~; font-family: Courier;" \|······<bs:offset>		\|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;">
	* По умолчанию значение 0.		<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.
	\|style="font-~~family~~: ~~Courier~~;" \|<~~bs:offset~~>2</~~bs:offset~~>		</span>
			<div class="mw-collapsible-content" style="font-weight: normal;">
			* По умолчанию значение 0.</div>
			</div>
	\|-		\|-
	\|5		\|005
	\|style="font-weight: ~~bold~~; font-family: Courier;" \|···</bs:listOptions>		\|style="font-weight: ; font-family: Courier;" \|···{{color\|#190dbf\|'''</{{color\|#660e7a\|bs:}}listOptions>'''}}
	\|		\|
	\|		\|
	\|		\| style="width:52em;"\|
	\|style="~~font-family~~: ~~Courier~~;" \|
	\|-		\|-
	\|6		\|006
	\|style="font-weight: ~~bold~~; font-family: Courier;" \|</ws:getPurposeListRequest>		\|style="font-weight: ; font-family: Courier;" \|{{color\|#190dbf\|'''</ws:getPurposeListRequest>'''}}
	\|
	\|		\|
	\|		\|
	\|style="~~font-family~~: ~~Courier~~;" \|		\| style="width:52em;"\|
	\|-		\|-
	\|}		\|}

Romanov-av: /* Спецификация ответа */

2017-10-30T08:49:06Z

Спецификация ответа

← Предыдущая версия		Версия от 08:49, 30 октября 2017
Строка 100:		Строка 100:
	\|[[PurposeList_v2.0\|dt:PurposeList]]		\|[[PurposeList_v2.0\|dt:PurposeList]]
	\|[1..1]		\|[1..1]
	\|Список ~~целей~~		\|Список назначений груза
	* total - всего записей;		* total - всего записей;
	* offset - смещение относительно первого элемента;		* offset - смещение относительно первого элемента;
Строка 110:		Строка 110:
	\|[[Purpose_v2.0\|dt:Purpose]]		\|[[Purpose_v2.0\|dt:Purpose]]
	\|[0..*]		\|[0..*]
	\|~~Цель~~		\|Назначение груза
	\|style="font-family: Courier;" \|		\|style="font-family: Courier;" \|
	\|-		\|-
Строка 117:		Строка 117:
	\|[[UUID\|bs:UUID]]		\|[[UUID\|bs:UUID]]
	\|[1..1]		\|[1..1]
	\|Идентификатор версии ~~цели~~		\|Идентификатор версии назначения груза
	\|style="font-family: Courier;" \|<bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>		\|style="font-family: Courier;" \|<bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
	\|-		\|-
Строка 124:		Строка 124:
	\|[[UUID\|bs:UUID]]		\|[[UUID\|bs:UUID]]
	\|[1..1]		\|[1..1]
	\|Глобальный идентификатор ~~цели~~		\|Глобальный идентификатор назначения груза
	\|style="font-family: Courier;" \|<bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid>		\|style="font-family: Courier;" \|<bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid>
	\|-		\|-
Строка 149:		Строка 149:
	\|[[VersionStatus\|bs:VersionStatus]]		\|[[VersionStatus\|bs:VersionStatus]]
	\|[1..1]		\|[1..1]
	\|Статус версии ~~цели~~		\|Статус версии назначения груза
	\|style="font-family: Courier;" \|<bs:status>100</bs:status>		\|style="font-family: Courier;" \|<bs:status>100</bs:status>
	\|-		\|-
Строка 156:		Строка 156:
	\|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]		\|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
	\|[1..1]		\|[1..1]
	\|Дата создания ~~цели~~		\|Дата создания назначения груза
	\|style="font-family: Courier;" \|<bs:createDate>2017-07-07T12:00:00</bs:createDate>		\|style="font-family: Courier;" \|<bs:createDate>2017-07-07T12:00:00</bs:createDate>
	\|-		\|-
Строка 163:		Строка 163:
	\|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]		\|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
	\|[1..1]		\|[1..1]
	\|Дата изменения ~~цели.~~		\|Дата изменения назначения груза
	\|style="font-family: Courier;" \|<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>		\|style="font-family: Courier;" \|<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
	\|-		\|-
Строка 170:		Строка 170:
	\|[[UUID\|bs:UUID]]		\|[[UUID\|bs:UUID]]
	\|[0..1]		\|[0..1]
	\|Идентификатор предыдущей версии записи ~~реестра целей~~		\|Идентификатор предыдущей версии записи
	\|style="font-family: Courier;" \|<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>		\|style="font-family: Courier;" \|<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
	\|-		\|-
Строка 177:		Строка 177:
	\|[[UUID\|bs:UUID]]		\|[[UUID\|bs:UUID]]
	\|[0..1]		\|[0..1]
	\|Идентификатор следующей версии записи ~~реестра целей.~~		\|Идентификатор следующей версии записи
	\|style="font-family: Courier;" \|<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>		\|style="font-family: Courier;" \|<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
	\|-		\|-
Строка 184:		Строка 184:
	\|[[String255\|bs:String255]]		\|[[String255\|bs:String255]]
	\|[1..1]		\|[1..1]
	\|Наименование ~~цели~~		\|Наименование назначения груза
	\|style="font-family: Courier;" \|<dt:name>в корм животным</dt:name>		\|style="font-family: Courier;" \|<dt:name>в корм животным</dt:name>
	\|-		\|-

Romanov-av: /* Пример запроса */

2017-10-30T08:37:16Z

Пример запроса

@@ Строка 223: / Строка 223: @@
 ==Пример запроса==
 <div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
-Запрос первых трех назначений груза, со смещением равным двум.
+Запрос первых трех назначений груза без смещения.
 <div class = "mw-collapsible-content">
 <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">
 </syntaxhighlight>
 </div>
@@ Строка 235: / Строка 245: @@
 <div class = "mw-collapsible-content">
 <syntaxhighlight lang="xml">
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 </syntaxhighlight>
 </div>

Romanov-av: /* Спецификация ответа */

2017-10-30T08:35:59Z

Спецификация ответа

← Предыдущая версия		Версия от 08:35, 30 октября 2017
Строка 81:		Строка 81:

	==Спецификация ответа==		==Спецификация ответа==
			{\| class="wikitable"
			! #
			! Название XML-элемента
			! Тип
			! Обязат.
			! Описание
			! Пример
			\|-
			\|1
			\|style="font-weight: bold; font-family: Courier;" \|<ws:getPurposeListResponse>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|2
			\|style="font-weight: bold; font-family: Courier;" \|···<dt:purposeList count="100" total="115" offset="0">
			\|[[PurposeList_v2.0\|dt:PurposeList]]
			\|[1..1]
			\|Список целей
			* total - всего записей;
			* offset - смещение относительно первого элемента;
			* count - количество выводимых записей.
			\|style="font-family: Courier;" \|
			\|-
			\|3
			\|style="font-weight: bold; font-family: Courier;" \|······<dt:purpose>
			\|[[Purpose_v2.0\|dt:Purpose]]
			\|[0..*]
			\|Цель
			\|style="font-family: Courier;" \|
			\|-
			\|4
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:uuid>
			\|[[UUID\|bs:UUID]]
			\|[1..1]
			\|Идентификатор версии цели
			\|style="font-family: Courier;" \|<bs:uuid>fedc3d90-053c-11e1-99b4-d8d385fbc9e8</bs:uuid>
			\|-
			\|5
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:guid>
			\|[[UUID\|bs:UUID]]
			\|[1..1]
			\|Глобальный идентификатор цели
			\|style="font-family: Courier;" \|<bs:guid>5b913350-e089-11e1-bcf3-b499babae7ea</bs:guid>
			\|-
			\|6
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:active>
			\|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
			\|[1..1]
			\|Является ли запись активной:
			* true - запись активна;
			* false - запись не активна.
			\|style="font-family: Courier;" \|<bs:active>true</bs:active>
			\|-
			\|7
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:last>
			\|[http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
			\|[1..1]
			\|Является ли версия записи последней:
			* true - да;
			* false - нет.
			\|style="font-family: Courier;" \|<bs:last>true</bs:last>
			\|-
			\|8
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:status>
			\|[[VersionStatus\|bs:VersionStatus]]
			\|[1..1]
			\|Статус версии цели
			\|style="font-family: Courier;" \|<bs:status>100</bs:status>
			\|-
			\|9
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:createDate>
			\|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
			\|[1..1]
			\|Дата создания цели
			\|style="font-family: Courier;" \|<bs:createDate>2017-07-07T12:00:00</bs:createDate>
			\|-
			\|10
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:updateDate>
			\|[http://www.w3.org/TR/xmlschema-2/#DateTime xs:DateTime]
			\|[1..1]
			\|Дата изменения цели.
			\|style="font-family: Courier;" \|<bs:updateDate>2017-07-07T12:00:00</bs:updateDate>
			\|-
			\|11
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:previous>
			\|[[UUID\|bs:UUID]]
			\|[0..1]
			\|Идентификатор предыдущей версии записи реестра целей
			\|style="font-family: Courier;" \|<bs:previous>c9781d68-8f7d-4fb6-a007-d7a14f0815f6</bs:previous>
			\|-
			\|12
			\|style="font-weight: bold; font-family: Courier;" \|·········<bs:next>
			\|[[UUID\|bs:UUID]]
			\|[0..1]
			\|Идентификатор следующей версии записи реестра целей.
			\|style="font-family: Courier;" \|<bs:next>8aaaac24-8e10-499e-b1a2-cda0bf3f5855</bs:next>
			\|-
			\|13
			\|style="font-weight: bold; font-family: Courier;" \|·········<dt:name>
			\|[[String255\|bs:String255]]
			\|[1..1]
			\|Наименование цели
			\|style="font-family: Courier;" \|<dt:name>в корм животным</dt:name>
			\|-
			\|14
			\|style="font-weight: bold; font-family: Courier;" \|······</dt:purpose>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|15
			\|style="font-weight: bold; font-family: Courier;" \|···</dt:purposeList>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|16
			\|style="font-weight: bold; font-family: Courier;" \|</ws:getPurposeListResponse>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|}

	==Описание ошибок==		==Описание ошибок==

Romanov-av: /* Спецификация запроса */

2017-10-30T08:35:25Z

Спецификация запроса

← Предыдущая версия		Версия от 08:35, 30 октября 2017
Строка 25:		Строка 25:

	==Спецификация запроса==		==Спецификация запроса==
			{\| class="wikitable"
			! #
			! Название XML-элемента
			! Тип
			! Обязат.
			! Описание
			! Пример
			\|-
			\|1
			\|style="font-weight: bold; font-family: Courier;" \|<ws:getPurposeListRequest>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|2
			\|style="font-weight: bold; font-family: Courier;" \|···<bs:listOptions>
			\|[[ListOptions\|bs:ListOptions]]
			\|[0..1]
			\|Параметры запрашиваемого списка.
			\|style="font-family: Courier;" \|
			\|-
			\|3
			\|style="font-weight: bold; font-family: Courier;" \|······<bs:count>
			\|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
			\|[0..1]
			\|Максимальное запрашиваемое количество объектов в списке.
			* По умолчанию значение 100;
			* Максимально возможное значение 1000.
			\|style="font-family: Courier;" \|<bs:count>10</bs:count>
			\|-
			\|4
			\|style="font-weight: bold; font-family: Courier;" \|······<bs:offset>
			\|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
			\|[0..1]
			\|Номер элемента, по которому осуществляется смещение первого элемента списка.
			* По умолчанию значение 0.
			\|style="font-family: Courier;" \|<bs:offset>2</bs:offset>
			\|-
			\|5
			\|style="font-weight: bold; font-family: Courier;" \|···</bs:listOptions>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|6
			\|style="font-weight: bold; font-family: Courier;" \|</ws:getPurposeListRequest>
			\|
			\|
			\|
			\|style="font-family: Courier;" \|
			\|-
			\|}

	==Спецификация ответа==		==Спецификация ответа==

Romanov-av: /* Общие сведения */

2017-10-30T06:19:02Z

Общие сведения

← Предыдущая версия		Версия от 06:19, 30 октября 2017
Строка 1:		Строка 1:
	==Общие сведения==		==Общие сведения==

	Операция '''GetPurposeList''' предназначена для получения списка актуальных ~~версий назначений~~ груза (active=true, last=true). Операция поддерживает постраничный вывод. Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.		Операция '''GetPurposeList''' предназначена для получения списка актуальных записей о назначениях груза (active=true, last=true). Операция поддерживает постраничный вывод. Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
	<!--===Используемые пространства имён и типы===		<!--===Используемые пространства имён и типы===
	{{столбцы}}		{{столбцы}}

Romanov-av: Новая страница: «==Общие сведения== Операция '''GetPurposeList''' предназначена для получения списка актуальных ве…»

2017-10-30T06:08:44Z

Новая страница: «==Общие сведения== Операция '''GetPurposeList''' предназначена для получения списка актуальных ве…»

Новая страница

==Общие сведения==

Операция '''GetPurposeList''' предназначена для получения списка актуальных версий назначений груза (active=true, last=true). Операция поддерживает постраничный вывод. Выполнение операции заканчивается либо возвратом списка назначений груза, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.


===Входные данные===
* параметры выводимого списка.

===Выходные данные===
* список актуальных записей назначений груза.

==Спецификация запроса==

==Спецификация ответа==

==Описание ошибок==
{| class="wikitable"
|-
! Ошибка !! Описание
|-
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
| '''IncorrectRequestFault''' || Некорректный запрос. Происходит в случае, если запрос не соответствует требованиям указанным в xsd.
|-
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
|}
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос первых трех назначений груза, со смещением равным двум.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">

</syntaxhighlight>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">

</syntaxhighlight>
</div>
</div>

[[Category:Ветис.API]]
[[Category:DictionaryService]]