DSAPIService Web Service

DSAPIService

Click here for a complete list of operations.

GetStatusInDocuSignConnectFormat

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/3.0/dsapi.asmx HTTP/1.1
Host: na4.docusign.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.docusign.net/API/3.0/GetStatusInDocuSignConnectFormat"

<?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>
    <GetStatusInDocuSignConnectFormat xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
    </GetStatusInDocuSignConnectFormat>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetStatusInDocuSignConnectFormatResponse xmlns="http://www.docusign.net/API/3.0">
      <GetStatusInDocuSignConnectFormatResult>
        <EnvelopeStatus>
          <RecipientStatuses>
            <RecipientStatus xsi:nil="true" />
            <RecipientStatus xsi:nil="true" />
          </RecipientStatuses>
          <TimeGenerated>dateTime</TimeGenerated>
          <EnvelopeID>string</EnvelopeID>
          <Subject>string</Subject>
          <UserName>string</UserName>
          <Email>string</Email>
          <Status>Any or Voided or Created or Deleted or Sent or Delivered or Signed or Completed or Declined or TimedOut or Template or Processing</Status>
          <Created>dateTime</Created>
          <Deleted>dateTime</Deleted>
          <Sent>dateTime</Sent>
          <Delivered>dateTime</Delivered>
          <Signed>dateTime</Signed>
          <Completed>dateTime</Completed>
          <Declined>dateTime</Declined>
          <TimedOut>dateTime</TimedOut>
          <ACStatus>string</ACStatus>
          <ACStatusDate>dateTime</ACStatusDate>
          <ACHolder>string</ACHolder>
          <ACHolderEmail>string</ACHolderEmail>
          <ACHolderLocation>string</ACHolderLocation>
          <SigningLocation>InPerson or Online</SigningLocation>
          <SenderIPAddress>string</SenderIPAddress>
          <EnvelopePDFHash>string</EnvelopePDFHash>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
          <VaultingDetails>
            <EODTransactionName>string</EODTransactionName>
            <EODTransactionID>string</EODTransactionID>
            <EODDocumentProfileID>string</EODDocumentProfileID>
          </VaultingDetails>
          <AutoNavigation>boolean</AutoNavigation>
          <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
          <AuthoritativeCopy>boolean</AuthoritativeCopy>
          <EnvelopeAttachment>
            <Attachment xsi:nil="true" />
            <Attachment xsi:nil="true" />
          </EnvelopeAttachment>
          <DocumentStatuses>
            <DocumentStatus xsi:nil="true" />
            <DocumentStatus xsi:nil="true" />
          </DocumentStatuses>
          <FormData>
            <xfdf xsi:nil="true" />
          </FormData>
          <VoidReason>string</VoidReason>
        </EnvelopeStatus>
        <DocumentPDFs>
          <DocumentPDF>
            <Name>string</Name>
            <PDFBytes>base64Binary</PDFBytes>
            <DocumentID>positiveInteger</DocumentID>
            <DocumentType>SUMMARY or CONTENT</DocumentType>
          </DocumentPDF>
          <DocumentPDF>
            <Name>string</Name>
            <PDFBytes>base64Binary</PDFBytes>
            <DocumentID>positiveInteger</DocumentID>
            <DocumentType>SUMMARY or CONTENT</DocumentType>
          </DocumentPDF>
        </DocumentPDFs>
        <TimeZone>string</TimeZone>
        <TimeZoneOffset>int</TimeZoneOffset>
      </GetStatusInDocuSignConnectFormatResult>
    </GetStatusInDocuSignConnectFormatResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api/3.0/dsapi.asmx HTTP/1.1
Host: na4.docusign.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetStatusInDocuSignConnectFormatResponse xmlns="http://www.docusign.net/API/3.0">
      <GetStatusInDocuSignConnectFormatResult>
        <EnvelopeStatus>
          <RecipientStatuses>
            <RecipientStatus xsi:nil="true" />
            <RecipientStatus xsi:nil="true" />
          </RecipientStatuses>
          <TimeGenerated>dateTime</TimeGenerated>
          <EnvelopeID>string</EnvelopeID>
          <Subject>string</Subject>
          <UserName>string</UserName>
          <Email>string</Email>
          <Status>Any or Voided or Created or Deleted or Sent or Delivered or Signed or Completed or Declined or TimedOut or Template or Processing</Status>
          <Created>dateTime</Created>
          <Deleted>dateTime</Deleted>
          <Sent>dateTime</Sent>
          <Delivered>dateTime</Delivered>
          <Signed>dateTime</Signed>
          <Completed>dateTime</Completed>
          <Declined>dateTime</Declined>
          <TimedOut>dateTime</TimedOut>
          <ACStatus>string</ACStatus>
          <ACStatusDate>dateTime</ACStatusDate>
          <ACHolder>string</ACHolder>
          <ACHolderEmail>string</ACHolderEmail>
          <ACHolderLocation>string</ACHolderLocation>
          <SigningLocation>InPerson or Online</SigningLocation>
          <SenderIPAddress>string</SenderIPAddress>
          <EnvelopePDFHash>string</EnvelopePDFHash>
          <CustomFields>
            <CustomField xsi:nil="true" />
            <CustomField xsi:nil="true" />
          </CustomFields>
          <VaultingDetails>
            <EODTransactionName>string</EODTransactionName>
            <EODTransactionID>string</EODTransactionID>
            <EODDocumentProfileID>string</EODDocumentProfileID>
          </VaultingDetails>
          <AutoNavigation>boolean</AutoNavigation>
          <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
          <AuthoritativeCopy>boolean</AuthoritativeCopy>
          <EnvelopeAttachment>
            <Attachment xsi:nil="true" />
            <Attachment xsi:nil="true" />
          </EnvelopeAttachment>
          <DocumentStatuses>
            <DocumentStatus xsi:nil="true" />
            <DocumentStatus xsi:nil="true" />
          </DocumentStatuses>
          <FormData>
            <xfdf xsi:nil="true" />
          </FormData>
          <VoidReason>string</VoidReason>
        </EnvelopeStatus>
        <DocumentPDFs>
          <DocumentPDF>
            <Name>string</Name>
            <PDFBytes>base64Binary</PDFBytes>
            <DocumentID>positiveInteger</DocumentID>
            <DocumentType>SUMMARY or CONTENT</DocumentType>
          </DocumentPDF>
          <DocumentPDF>
            <Name>string</Name>
            <PDFBytes>base64Binary</PDFBytes>
            <DocumentID>positiveInteger</DocumentID>
            <DocumentType>SUMMARY or CONTENT</DocumentType>
          </DocumentPDF>
        </DocumentPDFs>
        <TimeZone>string</TimeZone>
        <TimeZoneOffset>int</TimeZoneOffset>
      </GetStatusInDocuSignConnectFormatResult>
    </GetStatusInDocuSignConnectFormatResponse>
  </soap12:Body>
</soap12:Envelope>