GetRegionByUUID - История изменений

Dodonova-ev-130312 в 07:39, 15 декабря 2016

2016-12-15T07:39:07Z

← Предыдущая		Версия 07:39, 15 декабря 2016
Строка 170:		Строка 170:
	</div>		</div>
	</div>		</div>


			[[Category:Ветис.API]]
			[[Category:IkarService]]
			[[Category:Реестры]]

Novikov-dv-160810: "Пример запроса" изменено на "Примеры запросов"

2016-12-06T13:07:39Z

"Пример запроса" изменено на "Примеры запросов"

← Предыдущая		Версия 13:07, 6 декабря 2016
Строка 71:		Строка 71:
	\|}		\|}

	==~~Пример запроса~~==		==Примеры запросов==

	<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">		<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">

Novikov-dv-160810: Добавлен шаблон с параметром

2016-12-06T06:38:29Z

Добавлен шаблон с параметром

← Предыдущая		Версия 06:38, 6 декабря 2016
Строка 54:		Строка 54:
	===Объект [[#Объект getRegionByUuidResponse\|..Response]]/'''region'''===		===Объект [[#Объект getRegionByUuidResponse\|..Response]]/'''region'''===

	~~Объект, содержит информацию о регионе.~~		{{Ветис.API Ikar Region\|1}}

	{~~\| class="wikitable"~~
	\|-
	~~! Поле !! Описание !! Тип данных !! Обязательность~~
	\|-
	~~\| '''UUID''' \|\| Идентификатор версии записи о регионе страны в реестре системы Икар. \|\| [[UUID\|bs:UUID]] \|\| 1~~
	\|-
	~~\| '''GUID''' \|\| Глобальный идентификатор региона страны в реестре системы Икар. \|\| [[UUID\|bs:UUID]] \|\| 1~~
	\|-
	~~\| '''active''' \|\| Флаг, указывающий активна ли запись. \|\| [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] \|\| 1~~
	\|-
	~~\| '''last''' \|\| Флаг, указывающий, является ли версия записи последней. \|\| [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] \|\| 1~~
	\|-
	~~\| '''status''' \|\| Статус записи. \|\| [[VersionStatus\|bs:VersionStatus]] \|\| 1~~
	\|-
	~~\| '''createDate''' \|\| Дата создания записи. \|\| [https://www.w3.org/TR/xmlschema-2/#date xs:date] \|\| 1~~
	\|-
	~~\| '''updateDate''' \|\| Дата обновления записи. \|\| [https://www.w3.org/TR/xmlschema-2/#date xs:date] \|\| 1~~
	\|-
	~~\| '''previous''' \|\| Идентификатор предыдущей версии записи. \|\| [[UUID\|bs:UUID]] \|\| 0..1~~
	\|-
	~~\| '''next''' \|\| Идентификатор следующей версии записи. \|\| [[UUID\|bs:UUID]] \|\| 0..1~~
	\|-
	~~\| '''name''' \|\| Название региона. \|\| [https://www.w3.org/TR/xmlschema-2/#string xs:string] \|\| 1~~
	\|-
	~~\| '''englishName''' \|\| Название региона на английском языке. \|\|[https://www.w3.org/TR/xmlschema-2/#string xs:string] \|\| 0..1~~
	\|-
	~~\| '''view''' \|\| Представление объекта (обычно это название + название типа объекта).~~
	* Например: Владимирская обл.
	~~\|\| [[String255\|bs:String255]] \|\| 1~~
	\|-
	~~\| '''regionCode''' \|\| Код региона~~
	* Например: 33 (код Владимирской области).
	\|~~\| [https://www.w3.org/TR/xmlschema-2/#string xs:string] \|\| 0..~~1
	\|-
	~~\| '''type''' \|\| Название типа адресного объекта (например, область, район или город).~~
	* Например: обл.
	~~\|\| [[String255\|bs:String255]] \|\| 1~~
	\|-
	~~\| '''countryGuid'''\|\| Глобальный идентификатор страны, к которой относится данный объект. \|\| [[UUID\|bs:UUID]] \|\| 1~~
	\|-
	~~\| '''hasStreets''' \|\| Флаг, указывающий наличие улиц. \|\| [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] \|\| 1~~
	\|}

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

Novikov-dv-160810: Добавлено поле next.

2016-12-02T05:35:30Z

Добавлено поле next.

← Предыдущая		Версия 05:35, 2 декабря 2016
Строка 54:		Строка 54:
	===Объект [[#Объект getRegionByUuidResponse\|..Response]]/'''region'''===		===Объект [[#Объект getRegionByUuidResponse\|..Response]]/'''region'''===

	{~~{Ветис~~.~~API Ikar Region }~~}		Объект, содержит информацию о регионе.

			{\| class="wikitable"
			\|-
			! Поле !! Описание !! Тип данных !! Обязательность
			\|-
			\| '''UUID''' \|\| Идентификатор версии записи о регионе страны в реестре системы Икар. \|\| [[UUID\|bs:UUID]] \|\| 1
			\|-
			\| '''GUID''' \|\| Глобальный идентификатор региона страны в реестре системы Икар. \|\| [[UUID\|bs:UUID]] \|\| 1
			\|-
			\| '''active''' \|\| Флаг, указывающий активна ли запись. \|\| [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] \|\| 1
			\|-
			\| '''last''' \|\| Флаг, указывающий, является ли версия записи последней. \|\| [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] \|\| 1
			\|-
			\| '''status''' \|\| Статус записи. \|\| [[VersionStatus\|bs:VersionStatus]] \|\| 1
			\|-
			\| '''createDate''' \|\| Дата создания записи. \|\| [https://www.w3.org/TR/xmlschema-2/#date xs:date] \|\| 1
			\|-
			\| '''updateDate''' \|\| Дата обновления записи. \|\| [https://www.w3.org/TR/xmlschema-2/#date xs:date] \|\| 1
			\|-
			\| '''previous''' \|\| Идентификатор предыдущей версии записи. \|\| [[UUID\|bs:UUID]] \|\| 0..1
			\|-
			\| '''next''' \|\| Идентификатор следующей версии записи. \|\| [[UUID\|bs:UUID]] \|\| 0..1
			\|-
			\| '''name''' \|\| Название региона. \|\| [https://www.w3.org/TR/xmlschema-2/#string xs:string] \|\| 1
			\|-
			\| '''englishName''' \|\| Название региона на английском языке. \|\|[https://www.w3.org/TR/xmlschema-2/#string xs:string] \|\| 0..1
			\|-
			\| '''view''' \|\| Представление объекта (обычно это название + название типа объекта).
			* Например: Владимирская обл.
			\|\| [[String255\|bs:String255]] \|\| 1
			\|-
			\| '''regionCode''' \|\| Код региона
			* Например: 33 (код Владимирской области).
			\|\| [https://www.w3.org/TR/xmlschema-2/#string xs:string] \|\| 0..1
			\|-
			\| '''type''' \|\| Название типа адресного объекта (например, область, район или город).
			* Например: обл.
			\|\| [[String255\|bs:String255]] \|\| 1
			\|-
			\| '''countryGuid'''\|\| Глобальный идентификатор страны, к которой относится данный объект. \|\| [[UUID\|bs:UUID]] \|\| 1
			\|-
			\| '''hasStreets''' \|\| Флаг, указывающий наличие улиц. \|\| [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] \|\| 1
			\|}

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

Egorova-iv-150707: /* Общие сведения */

2016-12-01T08:08:49Z

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

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

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

	===Пространства имён и типы===		===Пространства имён и типы===

Novikov-dv-160810: Добавлен второй пример запроса.

2016-12-01T08:02:56Z

Добавлен второй пример запроса.

← Предыдущая		Версия 08:02, 1 декабря 2016
Строка 118:		Строка 118:
	</ws:getRegionByUuidResponse>		</ws:getRegionByUuidResponse>
	</SOAP-ENV:Body>		</SOAP-ENV:Body>
			</soapenv:Envelope>
			</syntaxhighlight>
			</div>
			</div>
			<br />
			<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/ikar/ws-definitions"
			xmlns:base="http://api.vetrf.ru/schema/cdm/base">
			<soapenv:Header/>
			<soapenv:Body>
			<ws:getRegionByUuidRequest>
			<base:uuid>20e60730-ff9f-442a-8d7b-a3acd20cb87c</base:uuid>
			</ws:getRegionByUuidRequest>
			</soapenv:Body>
			</soapenv:Envelope>
			</syntaxhighlight>
			</div>
			</div>
			<br />
			<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/">
			<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"/>
			<SOAP-ENV:Body xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
			<ws:getRegionByUuidResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" xmlns:ikar="http://api.vetrf.ru/schema/cdm/ikar" xmlns:ws="http://api.vetrf.ru/schema/cdm/ikar/ws-definitions">
			<ikar:region>
			<bs:uuid>20e60730-ff9f-442a-8d7b-a3acd20cb87c</bs:uuid>
			<bs:guid>d8327a56-80de-4df2-815c-4f6ab1224c50</bs:guid>
			<bs:active>true</bs:active>
			<bs:last>true</bs:last>
			<bs:status>100</bs:status>
			<bs:createDate>1900-01-01T00:00:00+03:00</bs:createDate>
			<bs:updateDate>2015-09-15T00:00:00+03:00</bs:updateDate>
			<ikar:name>Адыгея</ikar:name>
			<ikar:view>Республика Адыгея</ikar:view>
			<ikar:regionCode>01</ikar:regionCode>
			<ikar:type>Республика</ikar:type>
			<ikar:countryGuid>74a3cbb1-56fa-94f3-ab3f-e8db4940d96b</ikar:countryGuid>
			<ikar:hasStreets>false</ikar:hasStreets>
			</ikar:region>
			</ws:getRegionByUuidResponse>
			</SOAP-ENV:Body>
	</soapenv:Envelope>		</soapenv:Envelope>
	</syntaxhighlight>		</syntaxhighlight>
	</div>		</div>
	</div>		</div>

Egorova-iv-150707: /* Описание ошибок */

2016-11-11T05:38:30Z

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

← Предыдущая		Версия 05:38, 11 ноября 2016
Строка 66:		Строка 66:
	\| '''IncorrectRequestFault''' <!--\|\| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> \|\| Некорректный запрос. Возникает, если		\| '''IncorrectRequestFault''' <!--\|\| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> \|\| Некорректный запрос. Возникает, если
	* запрос не соответствует требованиям указанным в xsd;		* запрос не соответствует требованиям указанным в xsd;
	* указанный UUID отсутствует;
	* UUID указан в неверном формате.		* UUID указан в неверном формате.
	\|-		\|-

Egorova-iv-150707: /* Выходные данные */

2016-11-09T06:58:02Z

Выходные данные

← Предыдущая		Версия 06:58, 9 ноября 2016
Строка 24:		Строка 24:
	* идентификатор версии записи региона.		* идентификатор версии записи региона.

	===Выходные данные===		===[[#Объект getRegionByUuidResponse\|Выходные данные]]===
	* запись о регионе, у которой UUID совпадает с указанным в запросе идентификатором. Запись может быть не последней и/или не активной.		* запись о регионе, у которой UUID совпадает с указанным в запросе идентификатором. Запись может быть не последней и/или не активной.

Egorova-iv-150707: /* Входные данные */

2016-11-09T06:57:22Z

Входные данные

← Предыдущая		Версия 06:57, 9 ноября 2016
Строка 21:		Строка 21:
	{{столбцы/конец}}		{{столбцы/конец}}

	===[[#Объект ~~getRgionByUuidRequest~~\|Входные данные]]===		===[[#Объект getRegionByUuidRequest\|Входные данные]]===
	* идентификатор версии записи региона.		* идентификатор версии записи региона.

Egorova-iv-150707: /* Входные данные */

2016-11-09T06:57:14Z

Входные данные

← Предыдущая		Версия 06:57, 9 ноября 2016
Строка 21:		Строка 21:
	{{столбцы/конец}}		{{столбцы/конец}}

	===[[#Объект ~~getRgionByUUIDRequest~~\|Входные данные]]===		===[[#Объект getRgionByUuidRequest\|Входные данные]]===
	* идентификатор версии записи региона.		* идентификатор версии записи региона.