SynchEnvelope

Status and Managing Function Group

This method is only useful when the ‘Asynchronous’ flag is set to true on a CreateAndSendEnvelope call. It will determine when the queued envelope has been processed by the system.

// Create envelope as shown in linked code
DocuSignWeb.Envelope envelope = <create envelope>;
// Assign it a transaction ID and make it asynchronous send
envelope.TransactionID = System.Guid.NewGuid().ToString();
envelope.Asynchronous = true;
// Go ahead and send the envelope
DocuSignWeb.EnvelopeStatus status = _apiClient.SendEnvelope(envelope);
// Request a synch using the transaction ID and account ID
// but don't block it from processing
DocuSignWeb.SynchEnvelopeStatus synchStatus =
    _apiClient.SynchEnvelope(envelope.TransactionID, _accountId, false);
// Display the status we got back
Console.WriteLine("Synch envelope status is {0}", synchStatus.EnvelopeStatus);

Schema

Name	Schema Type	Description
TransactionID	LongString	External ID that is passed in CreateAndSendEnvelope when the ‘Asynchronous’ flag is set to true.
AccountID	DSXId	Account Id of the user who created the envelope
Block	Boolean	If true, this call will wait to return until the queued envelope is done processing. The max time it will wait is 10 minutes.

SynchEnvelopeStatus

Name	Schema Type	Description
EnvelopeStatus	EnvelopeStatusCode	Status of the envelope at that specific time. Enumeration values could be Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
EnvelopeID	LocalId	The unique Id for the envelope.