Versions Compared

Old Version 3

changes.mady.by.user Unknown User (gierlinger)

Saved on

compared with

New Version 4

changes.mady.by.user Unknown User (gierlinger)

Saved on

Key

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

...

Expand
titleAPI / Integration: What envelope status are available?


EnvelopeBulk
The status of an envelope can be:
  • Draft
    Started
      • Not sent envelope
  • InProgress
    • Canceled
    • Canceled
      • Envelope which was canceled by the sender. (final state).
    • Completed
    • Expired
    • Rejected
    • Template
      • CompletedWithWarnings
        • Envelope which does not need any more actions (final state).
      • Expired
        • Envelope reached expiration date. Can be restarted with a new expiration date.
      • Rejected
        • Rejected by one of the envelope recipient.
      • Template
        • Template which can be used to create envelopes with a given configuration.
      • ActionRequired
        • Waiting for your action.
      • WaitingForOthers
        • Waiting for actions of other recipients.
      • ExpiringSoon
        • The expiration date will soon the be reached.
      • InProgress
        • The envelope is in progress, waiting for next recipient in the order to do his/her action.
      • Draft
        • Not sent envelope
      • Canceled
        • Envelope which was canceled by the sender. (final state).
      • Completed
        • Envelope which does not need any more actions (final state).
      • Expired
        • Envelope reached expiration date. Can be restarted with a new expiration date.
      • Rejected
        • Rejected by one of the envelope recipient.
      • Template
        • Template which can be used to create envelopes with a given configuration.
      • Started
        • The envelope was started but needs to setup further metrics to the into status InProgress
      • CompletedWithWarnings
        • Warnings concerning long lived disposable
      • BulkCompleted
        • All envelopes of a bulk are completed
      • BulkPartlyCompleted
        • Not all envelopes of a bulk are completed
      • InProgress
        • The envelope is in progress, waiting for next recipient in the order to do his/her action.



      Expand
      titleIntegration: How do I use SIGNificant Apps with eSignAnyWhere or catch the WorkstepId?

      eSAW supports to send out links for the SIGNificant products automatically via notifications. Therefore you just have to add to the recipient configuration (XML) the following parameters:

      Code Block
      languagexml
      themeEclipse
      <envelope>
  <steps>
    <step>
      <recipients>
        <recipient>
          <addAndroidAppLink>0</addAndroidAppLink> <!-- 0 or 1 -->
          <addIosAppLink>0</addIosAppLink> <!-- 0 or 1 -->
          <addWindowsAppLink>0</addWindowsAppLink> <!-- 0 or 1 -->
        </recipient>
      </recipients>
    </step>
  </steps>
</envelope>

      Otherwise you can connect one workstep of eSignAnyWhere with one of the SIGNificant Apps. First you call the GetEnvelopeById_v1 with the envelopeID you got in sendEnvelope_v1. In the result you will find the workstepRedirectionURL. This URL forwards the SignAnywhere Viewer (Web-Client), but with the additional parameter &responseType=returnWorkstepId it returns the workstepId. Example:

      https://demo.xyzmo.com/workstepredirector/sign?identifier=8WNDxmUVr5V/aV1AAN49xjKuVsHMQEIQVuM/ktLNw1jOfWgaovF2mDg3uW9JJbp5Q/k7Yz92eoo=&responseType=returnWorkstepId

      With this WorkstepId you can now connect the SIGNificant product to the document. If the document is finsihed the workflow continues automatically.

      Other parameters are:

      • responseType=redirectToViewer – redirects to SAW Viewer (default)
      • responseType=redirectToAndroidApp – redirects to Android App
      • responseType=redirectToIOsApp – redirects to iOS App
      • responseType=redirectToWindowsApp – redirects to Windows App
      • responseType=returnWorkstepId – returns the WorkstepId for other integration types

      ...