Типы¶
Запрос на постановку серверных задач¶
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
DocumentId |
Идентификат ор документа |
CHAR |
36 |
Да |
Thumbprint |
Отпечаток сертификата, который будет использован при обработке запроса |
CHAR |
100 |
Да |
Commentary |
Комментарий , который будет использован при обработке запроса |
CHAR |
550 |
Нет |
TitleOrReceipts |
Последовательность готовых ответных титулов или квитанций, которые нужно использовать при постановке задачи |
TitleOrReceipt[] |
Нет |
Cведения о сертификате¶
Структура, предоставляющая сведения о сертификате.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
FirstName |
Имя |
String |
50 |
Нет |
Surname |
Фамилия |
String |
50 |
Нет |
MiddleName |
Отчество |
String |
50 |
Нет |
OrganizationName |
Наименование организации |
String |
250 |
Нет |
Inn |
ИНН организации |
String |
20 |
Нет |
Department |
Наименование подразделение |
String |
250 |
Нет |
Position |
Наименование должности |
String |
250 |
Нет |
Электронный почтовый адрес |
String |
250 |
Нет |
|
Snils |
Номер СНИЛС |
String |
14 |
Нет |
ValidFrom |
Дата начала действия сертификата |
DateTime |
Да |
|
ValidTo |
Дата окончания действия сертификата |
DateTime |
Да |
|
SerialNumber |
Серийный номер сертификата |
String |
100 |
Да |
Thumbprint |
Отпечаток сертификата |
String |
100 |
Да |
Ответный титул или квитанция¶
Структура ответного титула или квитанции представлена в таблице ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
DocumentId |
Идентификатор документа |
Guid |
Да |
|
Name |
Наименование титула или квитанции |
String |
500 |
Да |
ContentLinkId |
Ссылка на содержимое титула или квитанции |
String |
500 |
Да |
Перечень подписанных ответных титулов или квитанций¶
Структура запроса, содержащего перечень подписанных ответных титулов или квитанций для выполнения операции, представлена в таблице ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
SignedTitlesOrReceipts |
Перечень подписанных ответных титулов или квитанций |
SignedTitleOrReceipt[] |
Да |
Ответный титул или квитанция с подписью¶
Структура ответного титула или квитанции с подписью представлена в таблице ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
DocumentId |
Идентификатор документа |
Guid |
Да |
|
Name |
Наименование титула или квитанции |
String |
500 |
Да |
ContentLinkId |
Ссылка на содержимое титула или квитанции |
String |
500 |
Да |
SignatureLinkId |
Ссылка на содержимое подписи под титулом или квитанцией |
String |
500 |
Да |
Структура элемента фильтра по контрагентам¶
Структура элемента фильтра по контрагентам представлена ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
Inn |
ИНН контрагента |
String |
12 |
Да |
Kpp |
КПП юридического лица. Не задается для физических лиц. |
String |
9 |
Нет |
Параметры отправляемого пакета¶
Параметры отправляемого пакета представлены в таблице ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
Id |
Идентификатор пакета документов |
Guid |
Нет |
|
SenderBoxId |
Идентификатор ящика отправителя |
String |
50 |
Да |
ReceiverBoxId |
Идентификатор ящика получателя |
String |
50 |
Да |
IsPackageLocked |
Признак блокировки пакета |
Boolean |
Да |
|
UnsignedDocuments |
Перечень документов, которые нужно подписать на стороне сервера и отправить в составе пакета |
UnsignedDocumentToSend[] |
Нет |
|
SignedDocuments |
Перечень документов, подписанных на стороне клиента, которые нужно отправить в составе пакета |
SignedDocumentToSend[] |
Нет |
Событие документа¶
Структура, представляющая событие документа.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
EventId |
Идентификатор события |
Guid |
Да |
|
StatusCode |
Код статуса события |
StatusCode |
Да |
|
Comment |
Комментарий к событию |
String |
500 |
Нет |
OperatorDateTime |
Операторская дата и время получения события |
DateTime |
Да |
|
ErrorText |
Текст ошибки, если событие сигнализиру ет об ошибке |
String |
2000 |
Нет |
IsOutput |
Признак того, к какому документу относится событие - к входящему или исходящему. |
Boolean |
Да |
Вложение-контент¶
Структура, представляющая вложение-контент.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
EventId |
Идентификатор события |
Guid |
Нет |
|
Name |
Наименование файла вложения |
String |
500 |
Да |
Type |
Тип контента |
AttachmentType |
Да |
|
LinkId |
Ссылка на содержимое вложения в архивном хранилище |
String |
500 |
Да |
Signatures |
Последовательность подписей под контентом |
Signature[] |
Да |
Вложение-подпись¶
Структура, представляющая вложение-подпись.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
LinkId |
Ссылка на содержимое вложения в архиве |
String |
500 |
Да |
Type |
Тип подписи |
AttachmentType |
Да |
|
Certificate |
Сведения о сертификате |
Certificate |
Да |
Параметры отправки документа (серверное подписание)¶
Параметры отправляемого документа, который должен быть подписан на стороне сервера, представлены в таблице ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
DocumentId |
Идентификатор документа |
Guid |
Да |
|
ParentDocumentId |
Идентификатор родительского документа |
Guid |
Нет |
|
Type |
Типа документ |
DocumentType |
Да |
|
ContentFileName |
Имя файла с содержимым документа |
String |
500 |
Да |
ContentLinkId |
Ссылка на файл с содержимым документа |
String |
500 |
Да |
MetadataLinkId |
Ссылка на файл с метаданными документа |
String |
500 |
Да |
IsReceiverSignatureRequired |
Признак того, что документу требуется подпись получателя |
Boolean |
Да |
|
Comment |
Комментарий к документу |
String |
500 |
Нет |
Name |
Наименование документа |
String |
Да |
|
Number |
Номер документа |
String |
Нет |
|
Date |
Дата документа |
DateTime |
Нет |
|
Thumbprint |
Отпечаток сертификата |
String |
100 |
Да |
Параметры отправки документа (локальное подписание)¶
Параметры отправляемого документа, который был подписан на стороне клиента, представлены в таблице ниже.
Свойство |
Описание |
Тип |
Длина |
Обяз. |
|---|---|---|---|---|
DocumentId |
Идентификатор документа |
Guid |
Да |
|
ParentDocum entId |
Идентификатор родительского документа |
Guid |
Нет |
|
Type |
Типа документ |
DocumentType |
Да |
|
ContentFileName |
Имя файла с содержимым документа |
String |
500 |
Да |
ContentLinkId |
Ссылка на файл с содержимым документа |
String |
500 |
Да |
MetadataLinkId |
Ссылка на файл с метаданными документа |
String |
500 |
Да |
IsReceiverSignatureRequired |
Признак того, что документу требуется подпись получателя |
Boolean |
Да |
|
Comment |
Комментарий к документу |
String |
500 |
Нет |
Name |
Наименование документа |
String |
Да |
|
Number |
Номер документа |
String |
Нет |
|
Date |
Дата документа |
DateTime |
Нет |
|
SignatureFileName |
Имя файла подписи |
String |
500 |
Да |
SignatureLinkId |
Ссылка на файл подписи в архиве ИМ |
String |
500 |
Да |