Альбом форматов аис фссп россии

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

бет	60/62
Дата	20.06.2016
өлшемі	4.42 Mb.
	#150093
түрі	Реферат

1 ... 54 55 56 57 58 59 60 61 62

4.2.3. Сообщение веб-сервиса

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

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

Таблица 243:Тип данных «Сообщение веб-сервиса», DXBox

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Управляющий блок протокола	DXControl	DXControl	С	Н
Пакет документов	DXPack	DXPack	С	НМ
Квитанция пакета документов	DXReceipt	DXReceipt	С	НМ
Запрос фрагмента файла	DXFileRequest	DXFileRequest	С	НМ
Фрагмент файла	DXFileData	DXFileData	С	НМ
Квитанция файла	DXFileReceipt	DXFileReceipt	С	НМ
Запрос справочников	DXLookupTableRequest	DXLookupTableRequest	С	НМ
Данные справочников	DXLookupTableData	DXLookupTableData	С	НМ
Запрос на передачу документа веб-сервису	DXPutDocument	DXPutDocument	С	Н
Запрос результата обработки документа	DXGetDocumentResult	DXGetDocumentResult	С	Н
Уведомление документа	DXNotifyDocument	DXNotifyDocument	С	Н
Результат обращения к документу	DXDocumentResult	DXDocumentResult	С	Н
Контрольный запрос	DXSysInfoRequest	DXSysInfoRequest	С	Н
Контрольный ответ	DXSystemInfo	DXSystemInfo	С	Н

4.2.4. Служебные блоки

4.2.4.1. Базовый тип «Служебный блок»

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

Наименование типа данных в XSD-схеме: DXBlock. Тип данных является абстрактным, структуры данных этого типа не создаются. Описание типа данных приведено в таблице 244.

Таблица 244:Тип данных «Служебный блок», DXBlock

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Адреса отправителя и получателя блока	Direction	Direction	С	Н	При обмене данными через СМЭВ без использования подразделений может не заполняться.
Уникальный идентификатор блока	id	Id	А	О
Номер сессии	session_id	Id	А	Н
Последовательный номер сообщения в сессии	sequence	Integer	А	Н
Тип блока, на который данный блок является ответом	replyToType	BlockType	А	Н	Заполняются при формировании блока в ответ на какой-либо другой блок. Например, в квитанции на пакет эти реквизиты должны быть установлены.
Идентификатор блока, на который данный блок является ответом	replyTo	Id	А	Н
Дата и время включения блока в корневое сообщение протокола	time_sent	DateTime	А	О

4.2.4.2. Управляющий блок протокола

Тип данных «Управляющий блок протокола» предназначен для передачи данных о режимах работы протокола на стороне отправителя блока.

Наименование XML-элемента и типа данных в XSD-схеме: DXControl. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock Описание типа данных приведено в таблице 245.

Таблица 245:Тип данных «Управляющий блок протокола», DXControl

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

Режим работы пакетного обмена данными

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

Описание типа данных приведено в таблице 246.

Таблица 246:Тип данных «Режим работы пакетного обмена данными», DXControl/Pack

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Максимальное количество принимаемых пакетов	MaxCount	Integer	П	Н	Если это поле не заполнено, принимается значение по умолчанию - 1.
Номер максимального поколения пакета документов, имеющегося у получателя	GenerationId	Generation	П	Н

Режим работы файлового обмена

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

Описание типа данных приведено в таблице 247.

Таблица 247:Тип данных «Режим работы файлового обмена», DXControl/File

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

4.2.4.3. Пакет документов

Тип данных «Пакет документов» предназначен для передачи пакета документов

Наименование XML-элемента и типа данных в XSD-схеме: DXPack. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 248.

Таблица 248:Тип данных «Пакет документов», DXPack

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Дата создания пакета документов	DocDate	Date
Номер пакета документов в документообороте	DocNumber	DocumentNumber
Номер поколения	Generation	Generation
Подписал	Signed	PersonFullName
Данные документов для передачи по варианту 1 \|	Documents	DXPack/Documents
Конверты документов для передачи по варианту 2	Envelopes	DXPack/Envelopes
Технологические сообщения протокола обмена	Notes	DocNoteCollection			В этом поле могут быть указаны сведения о документах пакета, которые не удалось передать в составе пакета по причине системной ошибки.
Дата и время создания пакета	time_created	DateTime
Дата и время постановки пакета в очередь	time_queued	DateTime

Данные документов для передачи по варианту 1

Тип данных «Данные документов для передачи по варианту 1» предназначен для передачи документов в составе пакета.

Описание типа данных приведено в таблице 249.

Таблица 249:Тип данных «Данные документов для передачи по варианту 1», DXPack/Documents

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

Данные документов для передачи по варианту 2

Тип данных «Данные документов для передачи по варианту 2» предназначен для передачи документов в составе пакета.

Описание типа данных приведено в таблице 250.

Таблица 250:Тип данных «Данные документов для передачи по варианту 2», DXPack/Envelopes

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

Конверт

Тип данных «Конверт» предназначен для передачи документа, дополнительных реквизитов документа, информации о файлах, приложенных к документу.

Наименование типа данных в XSD-схеме : Envelope. Описание типа данных приведено в таблице 251.

Таблица 251:Тип данных «Конверт», Envelope

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Адреса отправителя и получателя документа	Direction	Direction	С	Н	Обязательно, если адреса не соответствуют адресу пакета.
Номер документа	DocNumber	DocumentNumber	П	Н
Дата документа	DocDate	Date	П	Н
Дополнительные атрибуты документов	DocumentAttrs	DocumentAttrs	С	Н
Данные документа \|	Document	DocumentContainer	С		Порядок заполнения полей см. в Руководстве по использованию веб-сервиса.
~~Информация о вложениях \|~~	~~Attachments~~	~~Attachments~~	С
Информация о вложениях в виде файла \|	AttachmentsFileInfo	FileInfo	С
~~Вложения в виде файла (менее 2К)~~	~~AttachmentsFileData~~	~~FileData~~	С
~~Информация о документе в виде файла \|~~	~~DocumentFileInfo~~	~~FileInfo~~	С
~~Документ в виде файла (менее 2К)~~	~~DocumentFileData~~	~~FileData~~	С
Идентификатор документа отправителя документа	doc_id	Id	А	Н
Код типа документа отправителя документа	doc_type	DocumentType	А	Н
Идентификатор конверта	id	Id	А	О
Наименование события в документообороте	event	Event	А	Н

Дополнительные атрибуты документа

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

Наименование типа данных в XSD-схеме : DocumentAttrs. Описание типа данных приведено в таблице 252.

Таблица 252:Тип данных «Дополнительные атрибуты документа», DocumentAttrs

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

Дополнительный атрибут документа

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

Наименование типа данных в XSD-схеме : DocumentAttr. Описание типа данных приведено в таблице 253.

Таблица 253:Тип данных «Дополнительный атрибут документа», DocumentAttr

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

Данные о вложенных файлах

Тип данных «Данные о вложенных файлах» предназначен для передачи информации о файлах, приложенных к документу.

Наименование типа данных в XSD-схеме : Attachments. Описание типа данных приведено в таблице 254.

Таблица 254:Тип данных «Данные о вложенных файлах», Attachments

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

4.2.4.4. Квитанция на пакет документов

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

Наименование XML-элемента и типа данных в XSD-схеме: DXReceipt. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 255.

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

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Статус обработки пакета	Status	ProcessResult	П	О
Информация об ошибке	ErrorMessage	MessageEx	С	Н
Технологические сообщения о приеме документов	Notes	DocNoteCollection	С	Н
Дата в время приема пакета	time_src_rcv	DateTime	А	Н

4.2.4.5. Запрос фрагмента файла

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

Наименование XML-элемента и типа данных в XSD-схеме: DXFileRequest. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 256.

Таблица 256:Тип данных «Запрос фрагмента файла», DXFileRequest

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

4.2.4.6. Фрагмент файла

Тип данных «Фрагмент файла» предназначен для передачи файла данных.

Наименование XML-элемента и типа данных в XSD-схеме: DXFileData. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 257.

Таблица 257:Тип данных «Фрагмент файла», DXFileData

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

4.2.4.7. Квитанция на фрагмент файла

Тип данных «Квитанция на фрагмент файла» предназначен для передачи подтверждения приема файла отправителю

Наименование XML-элемента и типа данных в XSD-схеме: DXFileReceipt. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 258.

Таблица 258:Тип данных «Квитанция на фрагмент файла», DXFileReceipt

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Информация о фрагменте файла	FileBlockInfo	FileBlockInfo	С	О
Статус обработки файла	Status	ProcessResult	П	О
Сообщение об ошибке	Message	MessageEx	С	Н

4.2.4.8. Запрос информации о системе

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

Наименование XML-элемента и типа данных в XSD-схеме: DXSysInfoRequest. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 259.

Таблица 259:Тип данных «Запрос информации о системе», DXSysInfoRequest

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

4.2.4.9. Информация о системе

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

Наименование XML-элемента и типа данных в XSD-схеме: DXSystemInfo. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 260.

Таблица 260:Тип данных «Информация о системе», DXSystemInfo

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Наименование системы	SystemName	Caption	П	О
Сведения об организации	Organization	OrganizationEx	С	Н
Сведения о подразделении	Department	DepartmentEx	С	Н

Наименование и код организации

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

Наименование типа данных в XSD-схеме : OrganizationEx. Описание типа данных приведено в таблице 261.

Таблица 261:Тип данных «Наименование и код организации», OrganizationEx

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Код организации	code	OrganizationCode	А	О
Наименование организации		Caption		Н	Передаётся в тексте элемента.

Наименование и код подразделения организации

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

Наименование типа данных в XSD-схеме : DepartmentEx. Описание типа данных приведено в таблице 262.

Таблица 262:Тип данных «Наименование и код подразделения организации», DepartmentEx

Заголовок элемента	Наименование элемента	Тип данных элемента	П/С/А	О(М)	Дополнительная информация
Код подразделения	code	DepartmentCode	А	О
Наименование подразделения		Caption		Н	Передаётся в тексте элемента.

4.2.4.10. Запрос данных справочника

Тип данных «Запрос данных справочника» предназначен для передачи веб-сервису запроса на данные справочника, хранящиеся в АИС.

Наименование XML-элемента и типа данных в XSD-схеме: DXLookupTableRequest. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 263.

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

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

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

Тип данных «Данные справочника» предназначен для передачи клиенту веб-сервиса данные справочника АИС.

Наименование XML-элемента и типа данных в XSD-схеме: DXLookupTableData. Данный тип расширяет базовый тип данных «Служебный блок», DXBlock. Описание типа данных приведено в таблице 264.

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

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

Данные справочника (внутренний)

Тип данных «Данные справочника (внутренний)» предназначен для передачи данных справочника в составе служебного блока «Данные справочника»

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

Таблица 265:Тип данных «Данные справочника (внутренний)», LookupTableData

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

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

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

1 ... 54 55 56 57 58 59 60 61 62