Т. П. Игнатьева / 20 г

Базовые типы данных для сообщений веб-сервиса

жүктеу/скачать 3 Mb.

бет	38/42
Дата	15.06.2016
өлшемі	3 Mb.
	#137111
түрі	Реферат

1 ... 34 35 36 37 38 39 40 41 42

4.1.2. Базовые типы данных для сообщений веб-сервиса

В данном разделе описаны типы данных, используемые для передачи служебной информации в сообщениях веб-сервиса.

4.1.2.1. Синхронный запрос

Тип данных «Синхронный запрос» используется для обобщения служебных реквизитов входящего сообщения синхронного вызова.

Наименование типа данных в XSD-схеме: SyncRq. Тип данных является абстрактным. Описание типа данных приведено в таблице 161.

Таблица 161:Тип данных «Синхронный запрос», SyncRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Ключ сообщения внешнего контрагента	externalKey	ExternalKeyType	П	Н
Адрес отправителя пакета	origin	RedAddress	С	О
Адрес получателя пакета	target	RedAddress	С	О

4.1.2.2. Ответ на синхронный запрос

Тип данных «Ответ на синхронный запрос» используется для обобщения служебных реквизитов исходящего сообщения синхронного вызова.

Наименование типа данных в XSD-схеме: SyncRs. Тип данных является абстрактным. Описание типа данных приведено в таблице 162.

Таблица 162:Тип данных «Ответ на синхронный запрос», SyncRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Ключ сообщения внешнего контрагента	inquiryKey	ExternalKeyType	П	О
Ключ сообщения АИС ФССП России	internalKey	InternalKeyType	П	О
Адрес отправителя пакета	origin	RedAddress	С	О
Адрес получателя пакета	target	RedAddress	С	О
Код ошибки	errorCode	ErrorCode	П	Н	Заполняется в случае, если системе не удалось обработать запрос на получение справочников.
Текст ошибки	errorText	ErrorText	П	Н

4.1.2.3. Запрос

Тип данных «Запрос» используется для обобщения служебных реквизитов входящего сообщения асинхронного вызова.

Наименование типа данных в XSD-схеме: Request. Тип данных является абстрактным. Описание типа данных приведено в таблице 163.

Таблица 163:Тип данных «Запрос», Request

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Ключ запроса внешнего контрагента	externalKey	ExternalKeyType	П	Н

4.1.2.4. Ответ на запрос

Тип данных «Ответ на запрос» используется для обобщения служебных реквизитов исходящего сообщения асинхронного вызова.

Наименование типа данных в XSD-схеме: Response. Тип данных является абстрактным. Описание типа данных приведено в таблице 164.

Таблица 164:Тип данных «Ответ на запрос», Response

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Ключ ответа на запрос АИС ФССП России	internalKey	InternalKeyType	П	О
Ключ запроса внешнего контрагента	requestKey	ExternalKeyType	П	Н

4.1.3. Параметры функции выполнения контрольного примера

В данном разделе описаны типы сообщений веб-сервиса для функции выполнения контрольного примера.

4.1.3.1. Диагностический запрос

Тип данных «Диагностический запрос» предназначен для входящего сообщения функции выполнения контрольного примера.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: TouchRq. Описание типа данных приведено в таблице 165.

Таблица 165:Тип данных «Диагностический запрос», TouchRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Параметр (произвольные данные), не возвращаемый отправителю	redRay	string	П	Н
Параметр (произвольные данные), возвращаемый отправителю	greenRay	string	П	Н

4.1.3.2. Ответ на диагностический запрос

Тип данных «Ответ на диагностический запрос» предназначен для исходящего сообщения функции выполнения контрольного примера.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: TouchRs. Описание типа данных приведено в таблице 166.

Таблица 166:Тип данных «Ответ на диагностический запрос», TouchRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Возвращаемый отправителю параметр диагностического запроса	greenRay	string	П	Н

4.1.4. Параметры функций обмена документами

В данном разделе описаны типы сообщений веб-сервиса для функции асинхронного обмена документами

4.1.4.1. Запрос исходящих пакетов

Тип данных «Запрос исходящих пакетов» предназначен для входящего сообщения функции получения исходящих документов веб-сервиса.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: GetMessagesRq. Тип данных расширяет базовый тип «Запрос», Request. Описание типа данных приведено в таблице 167.

Таблица 167:Тип данных «Запрос исходящих пакетов», GetMessagesRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Максимальное число сообщений с пакетами документов в ответе	maxCount	integer	П	Н
Номер последнего имеющегося у клиента веб-сервиса поколения пакета данных	clientGeneration	integer	П	Н	При передаче серверу данной переменной будут переданы пакеты данных, начиная с указанного значения (не включая переданное значение).

4.1.4.2. Исходящие пакеты

Тип данных «Исходящие пакеты» предназначен для входящего сообщения функции получения исходящих документов веб-сервиса.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: GetMessagesRs. Тип данных расширяет базовый тип «Ответ на запрос», Response. Описание типа данных приведено в таблице 168.

Таблица 168:Тип данных «Исходящие пакеты», GetMessagesRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Признак наличия сообщений помимо передаваемого ответа.	hasMore	boolean	П
Сообщение	messages	MessageCollection	С	Н	В настоящее время выполняется передача одного сообщения.

4.1.4.3. Квитанции на исходящие пакеты

Тип данных «Квитанции на исходящие пакеты» предназначен для входящего сообщения функции приема квитанции на исходящий пакет документов.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: NotifyMessagesRq. Тип данных расширяет базовый тип «Запрос», Request. Описание типа данных приведено в таблице 169.

Таблица 169:Тип данных «Квитанции на исходящие пакеты», NotifyMessagesRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Результат приема сообщений	messageResults	MessageResultCollection	П	О	В элементе status вложенного элемента MessageResult должно содержать значение «received» или «error»
Сообщения в адрес ФССП России	messages	MessageCollection	П	Н	Не используется

4.1.4.4. Результат приема квитанций на исходящие пакеты

Тип данных «Результат приема квитанций на исходящие пакеты» предназначен для исходящего сообщения функции получения квитанций на исходящие пакеты документов.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: NotifyMessagesRs. Тип данных расширяет базовый тип «Ответ на запрос», Response. Описание типа данных приведено в таблице 170.

Таблица 170:Тип данных «Результат приема квитанций на исходящие пакеты», NotifyMessagesRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Результат обработки уведомлений	notifyResults	MessageResultCollection	П	Н	Не используется
Результат обработки сообщений	messageResults	MessageResultCollection	С	Н	В элементе status вложенного элемента MessageResult должно содержать значение «notified»

4.1.4.5. Входящие пакеты документов

Тип данных «Входящие пакеты документов» предназначен для входящего сообщения функции приема пакетов документов от клиента веб-сервиса.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: PutMessagesRq. Тип данных расширяет базовый тип «Запрос», Request. Описание типа данных приведено в таблице 171.

Таблица 171:Тип данных «Входящие пакеты документов», PutMessagesRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Множество сообщений в адрес ФССП России	messages	MessageCollection	С	О

4.1.4.6. Квитанции на входящие пакеты документов

Тип данных «Квитанции на входящие пакеты документов» предназначен для исходящего сообщения функции приема входящих пакетов документов.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: PutMessagesRs. Тип данных расширяет базовый тип «Ответ на запрос», Response. Описание типа данных приведено в таблице 172.

Таблица 172:Тип данных «Квитанции на входящие пакеты документов», PutMessagesRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Результаты приема сообщений веб-сервисом ФССП России	results	MessageResultCollection	С	О	Поле StatusCode должно содержать значение «received» или «error»
Сообщения в адрес внешнего контрагента	messages	MessageCollection	С	Н	Не используется в текущей версии сервиса.

4.1.5. Сообщения функции обработки запросов ЕПГУ

В данном разделе описаны типы сообщений веб-сервиса для функции обработки запросов пользователя ЕПГУ.

4.1.5.1. Запрос на регистрацию заявления пользователя ЕПГУ

Тип данных «Запрос пользователя ЕПГУ» предназначен для входящего сообщения функции обработки запросов ЕПГУ

Наименование типа данных в XSD-схеме и элемента в XML-представлении: InquiryMessage. Тип данных расширяет базовый тип «Синхронный запрос», SyncRq. Описание типа данных приведено в таблице 173.

Таблица 173:Тип данных «Запрос на регистрацию заявления пользователя ЕПГУ», InquiryMessage

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Запрос реестра ИП по должнику	debtorIPListRequest	DebtorIPListRequestType	С	О	Допустим один и только один документ из всех возможных (choice).	Ответом на запрос является DebtorIPListResponseType «Список исполнительных производств по должнику»
Регистрация запроса о наличии ИП	IPSideRequestExistence	IPSideRequestExistenceType	С	О		Непосредственным ответом на направление в ФССП данных документов является документ IPReqAppResponseType «Подтверждение регистрации запроса или заявления в ОСП». Для получения ответа СПИ необходимо вызвать веб-сервис с документом IPReqAppResultRequestType «Запрос на получение ответов на заявления или запросы в ОСП»
Регистрация запроса о ходе ИП по исполнительному документу	IPSideRequestCourseID	IPSideRequestCourseIDType	С	О
Регистрация запроса о ходе ИП по номеру ИП	IPSideRequestCourseIP	IPSideRequestCourseIPType	С	О
Регистрация заявления стороны ИП в ОСП	IPSideApp	IPSideAppType	С	О
Регистрация заявления стороны ИП в ОСП (постановление СПИ)	IPSideAppSPIAct	IPSideAppSPIActType	С	О
Регистрация заявления на продление сроков ИП	IPSideAppProlong	IPSideAppProlongType	С	О
Регистрация заявления об отложении исполнительных действий от взыскателя	IPSideAppDelayByCrdr	IPSideAppDelayByCrdrType	С	О
Регистрация заявления о приостановлении ИП	IPSideAppSuspendIP	IPSideAppSuspendIPType	С	О
Регистрация заявления об отмене постановления о прекращении ИП от взыскателя	IPSideAppCancelBreak	IPSideAppCancelBreakType	С	О
Регистрация заявления о проверке правильности расчетов и перечислений по ИП от взыскателя	IPSideAppAccountingChk	IPSideAppAccountingChkType	С	О
Запрос на получение ответов на заявления или запросы в ОСП	IPReqAppResultRequest	IPReqAppResultRequestType	С	О		Ответом на запрос является IPReqAppResultResponseType «Ответы ОСП на запросы или заявления»
Запрос сведений ИП по номеру ИП	IPBriefInfoRequest	IPBriefInfoRequestType	С	О		Ответом на запрос является IPBriefInfoResponse «Сведения ИП»
Регистрация обращения гражданина	IPGeneralApplication	IPGeneralApplication	С	О
Жалоба в порядке подчиненности	ComplaintApplication	ComplaintApplication	С	О
ЭП	ds:Signature	Signature	C	НМ	Технологическая ЭП (накладывается сервером, формирующим сообщение).

4.1.5.2. Результат выполнения запроса пользователя ЕПГУ

Тип данных «Результат выполнения запроса пользователя ЕПГУ» предназначен для исходящего сообщения функции обработки запросов ЕПГУ

Наименование типа данных в XSD-схеме и элемента в XML-представлении: AnswerMessage. Тип данных расширяет базовый тип «Ответ на синхронный запрос», SyncRs. Описание типа данных приведено в таблице 174.

Таблица 174:Тип данных «Результат выполнения запроса пользователя ЕПГУ», AnswerMessage

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Список исполнительных производств по должнику	DebtorIPListResponseType	DebtorIPListResponseType	С	О	Возможен возврат одного и только одного документа из всех возможных (choice)
Подтверждение регистрации запроса или заявления в ОСП	IPReqAppResponseType	IPReqAppResponseType	С	О
Ответы ОСП на запросы или заявления	IPReqAppResultResponseType	IPReqAppResultResponseType	С	О
Сведения ИП	IPBriefInfoResponse	IPBriefInfoResponseType	С	О
ЭП	ds:Signature	Signature	C	НМ	Технологическая ЭП (накладывается сервером, формирующим сообщение).

4.1.6. Синхронная обработка

В данном разделе описаны типы сообщений веб-сервиса для функции автоматической обработки документов.

4.1.6.1. Запрос на автоматическую обработку документа

Тип данных «Запрос на автоматическую обработку документа» предназначен для входящего сообщения функции синхронной обработки документов.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: AutoProcessRq. Тип данных расширяет базовый тип «Синхронный запрос», SyncRq. Описание типа данных приведено в таблице 175.

Таблица 175:Тип данных «Запрос на автоматическую обработку документа», AutoProcessRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Запрос информации о наличии и реквизитах ИП \|	ipDataRequest	IPDataRequest	С	О
Запрос реестра ИП по должнику	debtorIPListRequest	DebtorIPListRequestType	С	О

4.1.6.2. Результат автоматической обработки документов

Тип данных «Результат автоматической обработки документов» предназначен для исходящего сообщения функции обработки запросов ЕПГУ

Наименование типа данных в XSD-схеме и элемента в XML-представлении: AutoProcessRs. Тип данных расширяет базовый тип «Ответ на синхронный запрос», SyncRs. Описание типа данных приведено в таблице 176.

Таблица 176:Тип данных «Результат автоматической обработки документов», AutoProcessRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Информация об исполнительных производствах \|	ipDataInfo	IPDataInfo	С	Н	Документ возвращается в случае отсутствия ошибок обработки входящего документа, если это предусмотрено схемой документооборота.
Список исполнительных производств	debtorIPListResponse	DebtorIPListResponseType	C	Н

4.1.7. Сообщения функции получения данных справочников

В данном разделе описаны типы сообщений веб-сервиса для функции предоставления данных справочников АИС ФССП России.

4.1.7.1. Запрос справочников

Тип данных «Запрос справочников» предназначен для входящего сообщения функции предоставления справочников.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: GetLookupTablesRq. Тип данных расширяет базовый тип «Синхронный запрос», SyncRq. Описание типа данных приведено в таблице 177.

Таблица 177:Тип данных «Запрос справочников», GetLookupTablesRq

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Запрос данных справочника	lookupTableQuery	LookupTableQuery	C	ОМ

Запрос справочника

Тип данных «Запрос справочника» предназначен для исходящего сообщения функции предоставления данных одного справочника в составе сообщения «Запрос справочников», GetLookupTablesRq

Наименование типа данных в XSD-схеме и элемента в XML-представлении: LookupTableQuery. Описание типа данных приведено в таблице 178.

Таблица 178:Тип данных «Запрос справочника», LookupTableQuery

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Тип справочника	lookupTable	LookupTableType	П	О
Дополнительное условие	filter	String_1_1000	П	Н	Указание данного значения позволяет при необходимости получить лишь часть справочника. Поддерживается только для справочника ОСП. Для получения только требуемых данных отделов следует указать выражение: «OspCode in [xxx, yyy, zzz...]»

4.1.7.2. Данные справочников

Тип данных «Данные справочников» предназначен для исходящего сообщения функции предоставления данных справочника

Наименование типа данных в XSD-схеме и XML-представлении: GetLookupTablesRs. Тип данных расширяет базовый тип «Ответ на синхронный запрос», SyncRs. Описание типа данных приведено в таблице 179.

Таблица 179:Тип данных «Данные справочников», GetLookupTablesRs

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Данные справочников	lookupTableData	LookupTableData	С	НМ	Заполняется в случае отсутствия ошибок

Данные справочника

Тип данных «Данные справочника» предназначен для предоставления данных одного справочника в составе сообщения «Данные справочников», GetLookupTablesRs

Наименование типа данных в XSD-схеме и элемента в XML-представлении: LookupTableData. Описание типа данных приведено в таблице 180.

Таблица 180:Тип данных «Данные справочника», LookupTableData

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Тип справочника	lookupTable	LookupTableType	П	О
Дополнительное условие	filter	String_1_1000	П	Н	Указывается значение запроса
Отдел судебных приставов \|	osp	OspProperty	С	НМ	Заполняется множеством записей одного справочника. При указании условия, которому не соответствуют данные справочника или при отсутствии записей в справочнике эти элементы будут отсутствовать.
Тип документа, удостоверяющего личность \|	idDocType	IdDocTypeProperty	С	НМ
Валюта	currency	CurrencyProperty	С	НМ

4.1.8. Сообщение о системной ошибке

Тип данных «Сообщение о системной ошибке» предназначен для сообщения клиенту о системной ошибке веб-сервиса, из-за которой невозможен возврат штатного сообщения результата вызова.

Наименование типа данных в XSD-схеме и элемента в XML-представлении: Error. Описание типа данных приведено в таблице 181.

Таблица 181:Тип данных «Сообщение о системной ошибке», Error

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Сообщение об ошибке	message	string	П	Н	В данных полях хранятся данные об ошибке. Это могут быть как сообщение и код ошибки подсистемы МВВ, так и сообщение и код ошибки операционной системы или иного программного обеспечения, используемого в обмене данными.
Код ошибки	code	int	П	О

жүктеу/скачать 3 Mb.

Достарыңызбен бөлісу:

1 ... 34 35 36 37 38 39 40 41 42