Versions Compared

Old Version 1

changes.mady.by.user Manuel Gierlinger

Saved on

compared with

New Version 2

changes.mady.by.user Christoph Bimminger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleCurrently Non-Supported Functionality

Please keep using API v5 if you are using one of this features listed below:

  • The mode SequenceOnlyRequiredTasks was removed from APIv6. A sender can still decide between NoSequenceEnforced and SequenceEnforced, and based on our experience SequenceEnforced can be used for those scenarios where SequenceOnlyRequiredTasks was used in some cases. We did this change to reduce complexity for integrators, and may decide in a future release if SequenceOnlyRequiredTasks needs to be added again.
  • Support for Swisscom Automatic Signatures / Swisscom Organization Certificates will be added in a later release.
  • Support for modifying SMS-OTP message (language and content) will be added in a later release.
  • Support for document links to bookmarks (i.e. within one document, or from one document to another). Only hyperlink areas to WWW resources are supported.
  • Some functionality formerly possible to be set via eSAW API in undocumented data structures, just interpreted in SIGNificant app, Kiosk etc but not available in SAW Viewer, are not contained in APIv6 models. Please check for such functionality, in case you used it before, already before starting to migrate to APIv6. This functionality will be added to APIv6 in a later product version, if it is considered as important product functionality. In case such functionality will be added to APIv6, then it will be available also in eSAW envelope creator and SAW Viewer.
  • User Management - there is currently no /user/* endpoint in API v6. For user management, keep using API v5, until we add new user management methods to API v6 in a future product version.

...

The envelope status values have been reviewed, and status values are now aligned with the status value shown in the WebUI.

API v1-v5API v6
 Status Values
envelope/get		Status Value
envelope/find		Status Value
envelope/get		Status Value
envelope/find		Comment
StartedActiveActive

Active
InProgress


ActionRequiredActionRequiredActionRequired is a status interpretation (derived from "Active") in context of the current user who calls envelope/find.
WaitingForOthersWaitingForOthersWaitingForOthers is a status interpretation (derived from "Active") in context of the current user who calls envelope/find.
CompletedCompletedCompletedCompleted
CompletedWithWarnings
CanceledCanceledCanceledCanceled
RejectedRejectedRejectedRejected
(ExpiringSoon)ExpiringSoonActiveExpiringSoonExpiringSoon was defined in the v5 model of envelope/get, but actually not used.
ExpiredExpiredExpiredExpired
BulkCompleted(n/a)(n/a)(n/a)Separated to API methods in "/envelopebulk" route
BulkPartlyCompleted (n/a)(n/a)(n/a)Separated to API methods in "/envelopebulk" route
DraftDraft(n/a)(n/a)Separated to API methods in "/draft" route
TemplateTemplate(n/a)(n/a)Separated to API methods in "/template" route

Complexity Reduction

Structural Changes for Bulk Sending via API & for managing parent envelopes resulting from bulk-sending

...

Instead of the API v5 "DocumentOptions" in the Steps element, document visibility is now managed in the "VisibilityOptions" of the Activity. The structure is very similar, but as mentioned above, the DocumentNumber now references to a defined number which is set in the Documents array instead of an implicit numbering based on array position.

Overview

Comparison

FigureDetailed description

Image Modified

  • Reminders are now configurable in the section "ReminderConfiguration" instead of directly in the envelope description
    • Additionally following reminder configurations can be set:
      • Enabled
      • FirstReminderInDays
      • ReminderResendIntervalInDays
      • BeforeExpirationInDays
  • Expiration can be be configured in the section "ExpirationConfiguration" instead of directly in the envelope description
    • Additionally following expiration settings are available:
      • ExpirationInSecondsAfterSending
      • ExpirationDate
  • Callback configurations can be set in the "CallbackConfiguration" section
    • Please note the following:
      • All available callbacks can be disabled or enabled
  • Email configurations can be found in the section "EmailConfiguration"
  • The section "Steps" which included the workstep configuration, authentication methods etc. was renamed to "Activities"

Signature Configuration

For automatic remote signatures, specifying the resulting stamp imprint appearance with on/off switches (DisplayExtraInformation, DisplayEmail, DisplayTransactionId, DisplayTransactionToken, DisplayPhoneNumber, DisplayIp, DisplayName, DisplaySignatureDate) is no longer supported. Compared to an APIv5 integration, all those fields are now ENABLED. To keep the API simpler, we decided to remove this functionality as the Stamp Imprint Configuration feature meanwhile offers more powerful options and still allows to hide single data rows.

...