Skip to navigation

RequestStatus and RequestStatusEx

View as Markdown

The RequestStatus and RequestStatusEx methods can be used to query the status of existing envelopes.

The RequestStatus method takes the element EnvelopeID for the envelope for which the status is requested. This Envelope ID must refer to an envelope created via the Create Envelope/CreateAndSendEnvelope method call.

Schema

RequestStatus

RequestStatusEx

// Create and send envelope as shown in linked code
DocuSignWeb.EnvelopeStatus eStatus = <create and send envelope>;
// Request the status of that envelope
DocuSignWeb.EnvelopeStatus status = _apiClient.RequestStatus(eStatus.EnvelopeID);
// Display the status for the envelope
Console.WriteLine("Status for envelope ID {0} is {1}", eStatus.EnvelopeID, status.Status);
NameSchema TypeDescription
EnvelopeIDDSXIdThe Envelope ID for which to retrieve status.

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/RequestStatus"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RequestStatus xmlns="http://www.docusign.net/API/3.0">
<EnvelopeID>string</EnvelopeID>
</RequestStatus>
</soap:Body>
</soap:Envelope>