В данном разделе описаны служебные составные типы данных, используемые в служебных блоках веб-сервиса.
4.2.2.1. Сообщение
Тип данных «Сообщение» предназначен для различных сообщений, передаваемых в составе служебных блоков сообщений веб-сервиса.
Наименование типа данных в XSD-схеме: MessageEx. Описание типа данных приведено в таблице 233.
Таблица 233:Тип данных «Сообщение», MessageEx
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Код
|
сode
|
MessageCode
|
А
|
О
|
|
Текст
|
|
MessageText
|
П
|
Н
|
Текст элемента типа.
| 4.2.2.2. Адрес в формате «Ред Софт»
Тип данных «Адрес в формате "Ред Софт"» предназначен для передачи адреса контрагента или подразделения контрагента.
Наименование типа данных в XSD-схеме: RedAddress. Описание типа данных приведено в таблице 234.
Таблица 234:Тип данных «Адрес в формате "Ред Софт"», RedAddress
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Код организации
|
Org
|
OrganizationCode
|
П
|
О
|
|
Код подразделения
|
Dept
|
DepartmentCode
|
П
|
Н
|
| 4.2.2.3. Направление передачи данных
Тип данных «Направление передачи данных» предназначен для передачи направления, в котором передаются данные. Включает в себя адреса отправителя, получателя и код протокола
Наименование типа данных в XSD-схеме : Direction. Описание типа данных приведено в таблице 235.
Таблица 235:Тип данных «Направление передачи данных», Direction
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Отправитель
|
Sender
|
RedAddress
|
С
|
О
|
|
Получатель
|
Recipient
|
RedAddress
|
С
|
О
|
|
Протокол
|
Protocol
|
ProtocolCode
|
П
|
О
|
| 4.2.2.4. Ссылка на документ
Тип данных «Ссылка на документ» предназначен для передачи ссылки на ранее принятый или отправленный документ.
Наименование типа данных в XSD-схеме : DocumentRef. Описание типа данных приведено в таблице 236.
Таблица 236:Тип данных «Ссылка на документ», DocumentRef
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Номер документа
|
DocNumber
|
DocumentNumber
|
П
|
Н
|
|
Дата документа
|
DocDate
|
Date
|
П
|
Н
|
|
Код типа документа
|
doc_type
|
DocumentType
|
А
|
Н
|
|
Уникальный идентификатор документа в АИС отправителя
|
id
|
Id
|
А
|
О
|
|
Идентификатор конверта в АИС отправителя
|
env_id
|
Id
|
А
|
Н
|
|
Идентификатор документа в АИС получателя
|
receiver_id
|
Id
|
А
|
Н
|
| 4.2.2.5. Технологические сообщения протокола обмена данными
Тип данных «Технологические сообщения протокола обмена данными» предназначен для передачи соответствующих данных.
Наименование типа данных в XSD-схеме : DocNoteCollection. Описание типа данных приведено в таблице 237.
Таблица 237:Тип данных «Технологические сообщения протокола обмена данными», DocNoteCollection
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Технологическое сообщение протокола обмена данными
|
Note
|
DocNote
|
С
|
ОМ
|
| 4.2.2.6. Технологическое сообщение протокола обмена данными
Тип данных «Технологическое сообщение протокола» предназначен для передачи квитанции о результатах приёма документа.
Наименование типа данных в XSD-схеме : DocNote. Описание типа данных приведено в таблице 238.
Таблица 238:Тип данных «Технологическое сообщение протокола», DocNote
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Текст и код сообщения
|
Message
|
MessageEx
|
С
|
О
|
|
Информация о документе
|
DocRef
|
DocumentRef
|
С
|
Н
|
|
Статус приема документа
|
Status
|
ProcessResult
|
П
|
Н
|
|
Дата формирования сообщения
|
timestamp
|
DateTime
|
А
|
Н
|
|
Идентификатор сообщения
|
id
|
Id
|
А
|
Н
|
| 4.2.2.7. Информация о файле
Тип данных «Информация о файле» предназначен для передачи информации о файле, передаваемом отдельно от документа (вне XML-структуры документа)
Наименование типа данных в XSD-схеме : FileInfo. Описание типа данных приведено в таблице 239.
Таблица 239:Тип данных «Информация о файле», FileInfo
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Полный размер файла в байтах
|
size
|
FileSize
|
А
|
О
|
|
Тип файла
|
type
|
FileType
|
А
|
О
|
В текущей реализации протокола поддерживается только режим ALL_ATTACHMENTS.
|
Имя файла
|
name
|
FileName
|
А
|
Н
|
|
MIME-тип содержимого файла
|
content_type
|
MimeType
|
А
|
Н
|
|
Кодировка текстового файла
|
encoding
|
CharacterSet
|
А
|
Н
|
|
Идентификатор пакета
|
pack_id
|
Id
|
А
|
Н
|
Заполняется для пакетного режима передачи данных.
|
Идентификатор документа
|
doc_id
|
Id
|
А
|
Н
|
Заполняется для типа файла DOCUMENT, ALL_ATTACHMENTS, SINGLE_ATTACHMENT.
|
Идентификатор вложения
|
attach_id
|
Id
|
А
|
Н
|
Заполняется для типа файла SINGLE_ATTACHMENT.
| 4.2.2.8. Информация о фрагменте файла
Тип данных «Информация о фрагменте файла» предназначен для передачи информации о фрагменте файла, передаваемого отдельно от документа (вне XML-структуры документа)
Наименование типа данных в XSD-схеме : FileBlockInfo. Описание типа данных приведено в таблице 240.
Таблица 240:Тип данных «Информация о фрагменте файла», FileBlockInfo
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Полный размер файла в байтах
|
size
|
FileSize
|
А
|
О
|
|
Тип файла
|
type
|
FileType
|
А
|
О
|
В текущей реализации протокола поддерживается только режим ALL_ATTACHMENTS.
|
Имя файла
|
name
|
FileName
|
А
|
Н
|
|
MIME-тип содержимого файла
|
content_type
|
MimeType
|
А
|
Н
|
|
Кодировка текстового файла
|
encoding
|
CharacterSet
|
А
|
Н
|
|
Идентификатор пакета
|
pack_id
|
Id
|
А
|
Н
|
Заполняется для пакетного режима передачи данных.
|
Идентификатор документа
|
doc_id
|
Id
|
А
|
Н
|
Заполняется для типа файла DOCUMENT, ALL_ATTACHMENTS, SINGLE_ATTACHMENT.
|
Идентификатор вложения
|
attach_id
|
Id
|
А
|
Н
|
Заполняется для типа файла SINGLE_ATTACHMENT.
|
Смещение от начала файла, байт
|
offset
|
FilePos
|
А
|
Н
|
|
Длина фрагмента файла в байтах
|
length
|
FileSize
|
А
|
Н
|
| 4.2.2.9. Данные файла
Тип данных «Данные файла» предназначен для передачи информации файла, передаваемого отдельно от документа (вне XML-структуры документа)
Наименование типа данных в XSD-схеме : FileData. Описание типа данных приведено в таблице 241.
Таблица 241:Тип данных «Данные файла», FileData
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Полный размер файла в байтах
|
size
|
FileSize
|
А
|
О
|
|
Тип файла
|
type
|
FileType
|
А
|
О
|
В текущей реализации протокола поддерживается только режим ALL_ATTACHMENTS.
|
Имя файла
|
name
|
FileName
|
А
|
Н
|
|
MIME-тип содержимого файла
|
content_type
|
MimeType
|
А
|
Н
|
|
Кодировка текстового файла
|
encoding
|
CharacterSet
|
А
|
Н
|
|
Идентификатор пакета
|
pack_id
|
Id
|
А
|
Н
|
Заполняется для пакетного режима передачи данных.
|
Идентификатор документа
|
doc_id
|
Id
|
А
|
Н
|
Заполняется для типа файла DOCUMENT, ALL_ATTACHMENTS, SINGLE_ATTACHMENT.
|
Идентификатор вложения
|
attach_id
|
Id
|
А
|
Н
|
Заполняется для типа файла SINGLE_ATTACHMENT.
|
Данные файла
|
|
base64Binary
|
П
|
О
|
Передаются в тексте элемента в формате base64 или в виде ссылки на MTOM-вложение.
| 4.2.2.10. Данные фрагмента файла
Тип данных «Данные фрагмента файла» предназначен для передачи данных фрагмента файла, передаваемого отдельно от документа (вне XML-структуры документа)
Наименование типа данных в XSD-схеме : FileDataBlock. Описание типа данных приведено в таблице 242.
Таблица 242:Тип данных «Данные фрагмента файла», FileDataBlock
Заголовок элемента
|
Наименование элемента
|
Тип данных элемента
|
П/С/А
|
О(М)
|
Дополнительная информация
|
Полный размер файла в байтах
|
size
|
FileSize
|
А
|
О
|
|
Тип файла
|
type
|
FileType
|
А
|
О
|
В текущей реализации протокола поддерживается только режим ALL_ATTACHMENTS.
|
Имя файла
|
name
|
FileName
|
А
|
Н
|
|
MIME-тип содержимого файла
|
content_type
|
MimeType
|
А
|
Н
|
|
Кодировка текстового файла
|
encoding
|
CharacterSet
|
А
|
Н
|
|
Идентификатор пакета
|
pack_id
|
Id
|
А
|
Н
|
Заполняется для пакетного режима передачи данных.
|
Идентификатор документа
|
doc_id
|
Id
|
А
|
Н
|
Заполняется для типа файла DOCUMENT, ALL_ATTACHMENTS, SINGLE_ATTACHMENT.
|
Идентификатор вложения
|
attach_id
|
Id
|
А
|
Н
|
Заполняется для типа файла SINGLE_ATTACHMENT.
|
Смещение от начала файла, байт
|
offset
|
FilePos
|
А
|
Н
|
|
Длина фрагмента файла в байтах
|
length
|
FileSize
|
А
|
Н
|
|
Данные фрагмента файла
|
|
base64Binary
|
П
|
О
|
Передаются в тексте элемента в формате base64 или в виде ссылки на MTOM-вложение.
|
Достарыңызбен бөлісу: |
