Получение функциональных особенностей операторов¶

Запрос: GET /OperatorFeatures?id=string

HTTP-заголовки:

Authorization: Bearer access_token
Accept: application/json

Описание запроса¶

Запрос позволяет получить список функциональных особенностей операторов ЭДО или EDI-провайдеров применительно к текущей версии Продукта.

Код оператора задается параметром id.

Запрос может использоваться для импорта данных во внешнюю систему. На основе этих данных можно строить бизнес-логику и/или пользовательский интерфейс внешней системы. Например, можно отключать возможность объединения документов в пакет, если оператор не поддерживает работу с пакетами и т. д.

Примечание

Код оператора можно определить из параметров оператора.

Ответ на запрос¶

Ответ на запрос содержит JSON с перечнем функциональных особенностей:

{
    "Value": "string",                                  // код оператора ЭДО
    "Description": "string",                            // отображаемое наименование оператора ЭДО
    "SupportsPackages": true,                           // поддерживает работу с пакетами
    "PackageLockMode": 0,                               // режим блокировки пакетов
    "SupportsPackageRevocation": true,                  // поддерживает пакетное аннулирование
    "SupportsSendingInvitationByFnsId": true,           // поддерживает отправку приглашений по ФНС-идентификатору
    "SupportsSendingInvitationInRoaming": true,         // поддерживает отправку приглашений в роуминг
    "SupportsInvitationRevocation": true,               // поддерживает отзыв приглашений к ЭДО
    "SupportsRelationshipBreaking": true,               // поддерживает разрыв отношений партнерства
    "RequiresEmailForInvitation": true,                 // требует передачу e-mail для отправки приглашения к ЭДО
    "SupportsInvitationAcceptanceOrRejection": true,    // поддерживает приемку или отклонение приглашений к ЭДО
    "SupportsDocumentRevocation": true,                 // поддерживает аннулирование документов
    "SupportsDocumentMetadata": true,                   // поддерживает работу с метаданными документов
    "SupportsSignatureRequest": true,                   // поддерживает запрос подписи получателя при отправке документов
    "SupportsTorg2Acceptance": true,                    // поддерживает приемку ТОРГ-2
    "Torg2AcceptanceContent": 0,                        // контент, который отправляется при приемке ТОРГ-2
    "SupportsZipDownloading": true,                     // поддерживает выгрузку zip-архива оператора
    "SupportsPowerOfAttorneyDocflow": true              // поддерживает документооборот доверенностей
}

В поле Value возвращается переданный код оператора.

В поле Description возвращается отображаемое наименование оператора.

Особенности работы с пакетами документов¶

Поле SupportsPackages определяет, поддерживает ли оператор работу с пакетами документов.

Поле PackageLockMode определяет, какой режим блокировки пакетов используется у оператора. Возможные варианты:

0 - пакет документов всегда разблокирован. Действия с документами пакета выполняются отдельно для каждого документа.
1 - пакет документов всегда заблокирован. Действия с документами пакета выполняются одновременно для всех документов пакета.
2 - режим блокировки пакета определяется пользователем при отправке в данных пакета.

Поле SupportsPackageRevocation определяет, будет ли аннулирование выполняться одновременно для всех документов пакета, независимо от режима блокировки пакета.

Особенности работы с приглашениями к ЭДО¶

Поле SupportsSendingInvitationByFnsId определяет, можно ли отправить приглашение к ЭДО по ФНС-идентификатору контрагента.

Поле SupportsSendingInvitationInRoaming определяет, можно ли отправить приглашение к ЭДО в роуминг.

Поле SupportsInvitationRevocation определяет, можно ли отзывать отправленные, но еще не принятые контрагентами, приглашения к ЭДО.

Поле SupportsRelationshipBreaking определяет, можно ли разрывать отношения партнерства, ранее установленные путем обмена приглашениями к ЭДО.

Поле RequiresEmailForInvitation определяет, нужно ли передавать e-mail для отправки приглашения к ЭДО.

Поле SupportsInvitationAcceptanceOrRejection определяет, можно ли принимать либо отклонять полученные от контрагентов приглашения к ЭДО.

Особенности выполнения действий с документами¶

Поле SupportsDocumentRevocation определяет, можно ли аннулировать документы, отправленные или полученные через оператора.

Поле SupportsDocumentMetadata определяет, можно ли передавать метаданные документов через оператора.

Поле SupportsSignatureRequest определяет, можно ли передавать требование запроса подписи при отправке документов через оператора.

Поле SupportsTorg2Acceptance определяет, поддерживает ли оператор приемку для ТОРГ-2. Регламент обмена ТОРГ-2 не предусматривает приемку, однако, у некоторых операторов можно подписывать непосредственно сам ТОРГ-2 на стороне продавца, у некоторых операторов под приемкой ТОРГ-2 понимается отправка файла дополнительных сведений, у некоторых подписывается непосредственно ТОРГ-2 и отправляется файл доп. сведений.

Поле Torg2AcceptanceContent определяет, что именно отправляется продавцу при приемке ТОРГ-2:

0 - продавец подписывает непосредственно ТОРГ-2 и отправляет свою подпись покупателю;
1 - продавец формирует и подписывает файл дополнительных сведений и отправляет его покупателю;
2 - продавец подписывает непосредственно ТОРГ-2 и отправляет свою подпись покупателю, а также формирует и подписывает файл дополнительных сведений и тоже отправляет его покупателю.

Поле SupportsPowerOfAttorneyDocflow определяет, поддерживает ли оператор документооборот доверенностей.

Особенности работы с zip-архивами¶

Поле SupportsZipDownloading определяет, поддерживает ли оператор выгрузку zip-архивов оператора.