APIService Web Service

APIService

Click here for a complete list of operations.

RequestStatusesWithDocumentFields

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/api.asmx HTTP/1.1
Host: na2.docusign.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.docusign.net/API/3.0/RequestStatusesWithDocumentFields"

<?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>
    <RequestStatusesWithDocumentFields xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeStatusFilter>
        <UserInfo>
          <UserName>string</UserName>
          <Email>string</Email>
        </UserInfo>
        <AccountId>string</AccountId>
        <BeginDateTime d5p1:statusQualifier="string" xmlns:d5p1="http://www.docusign.net/API/3.0" />
        <EndDateTime>dateTime</EndDateTime>
        <Statuses>
          <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>
          <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>
        </Statuses>
        <EnvelopeIds>
          <EnvelopeId>string</EnvelopeId>
          <EnvelopeId>string</EnvelopeId>
        </EnvelopeIds>
        <StartAtIndex>nonNegativeInteger</StartAtIndex>
        <ACStatus>Unknown or Original or Transferred or AuthoritativeCopy or AuthoritativeCopyExportPending or AuthoritativeCopyExported or DepositPending or Deposited or DepositedEO or DepositFailed</ACStatus>
      </EnvelopeStatusFilter>
    </RequestStatusesWithDocumentFields>
  </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>
    <RequestStatusesWithDocumentFieldsResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestStatusesWithDocumentFieldsResult>
        <ResultSetSize>int</ResultSetSize>
        <EnvelopeStatusFilter>
          <UserInfo>
            <UserName>string</UserName>
            <Email>string</Email>
          </UserInfo>
          <AccountId>string</AccountId>
          <BeginDateTime d6p1:statusQualifier="string" xmlns:d6p1="http://www.docusign.net/API/3.0" />
          <EndDateTime>dateTime</EndDateTime>
          <Statuses>
            <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>
            <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>
          </Statuses>
          <EnvelopeIds>
            <EnvelopeId>string</EnvelopeId>
            <EnvelopeId>string</EnvelopeId>
          </EnvelopeIds>
          <StartAtIndex>nonNegativeInteger</StartAtIndex>
          <ACStatus>Unknown or Original or Transferred or AuthoritativeCopy or AuthoritativeCopyExportPending or AuthoritativeCopyExported or DepositPending or Deposited or DepositedEO or DepositFailed</ACStatus>
        </EnvelopeStatusFilter>
        <EnvelopeStatuses>
          <EnvelopeStatus>
            <RecipientStatuses xsi:nil="true" />
            <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 xsi:nil="true" />
            <VaultingDetails xsi:nil="true" />
            <AutoNavigation>boolean</AutoNavigation>
            <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
            <AuthoritativeCopy>boolean</AuthoritativeCopy>
            <EnvelopeAttachment xsi:nil="true" />
            <DocumentStatuses xsi:nil="true" />
            <FormData xsi:nil="true" />
            <VoidReason>string</VoidReason>
          </EnvelopeStatus>
          <EnvelopeStatus>
            <RecipientStatuses xsi:nil="true" />
            <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 xsi:nil="true" />
            <VaultingDetails xsi:nil="true" />
            <AutoNavigation>boolean</AutoNavigation>
            <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
            <AuthoritativeCopy>boolean</AuthoritativeCopy>
            <EnvelopeAttachment xsi:nil="true" />
            <DocumentStatuses xsi:nil="true" />
            <FormData xsi:nil="true" />
            <VoidReason>string</VoidReason>
          </EnvelopeStatus>
        </EnvelopeStatuses>
      </RequestStatusesWithDocumentFieldsResult>
    </RequestStatusesWithDocumentFieldsResponse>
  </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/api.asmx HTTP/1.1
Host: na2.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>
    <RequestStatusesWithDocumentFields xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeStatusFilter>
        <UserInfo>
          <UserName>string</UserName>
          <Email>string</Email>
        </UserInfo>
        <AccountId>string</AccountId>
        <BeginDateTime d5p1:statusQualifier="string" xmlns:d5p1="http://www.docusign.net/API/3.0" />
        <EndDateTime>dateTime</EndDateTime>
        <Statuses>
          <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>
          <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>
        </Statuses>
        <EnvelopeIds>
          <EnvelopeId>string</EnvelopeId>
          <EnvelopeId>string</EnvelopeId>
        </EnvelopeIds>
        <StartAtIndex>nonNegativeInteger</StartAtIndex>
        <ACStatus>Unknown or Original or Transferred or AuthoritativeCopy or AuthoritativeCopyExportPending or AuthoritativeCopyExported or DepositPending or Deposited or DepositedEO or DepositFailed</ACStatus>
      </EnvelopeStatusFilter>
    </RequestStatusesWithDocumentFields>
  </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>
    <RequestStatusesWithDocumentFieldsResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestStatusesWithDocumentFieldsResult>
        <ResultSetSize>int</ResultSetSize>
        <EnvelopeStatusFilter>
          <UserInfo>
            <UserName>string</UserName>
            <Email>string</Email>
          </UserInfo>
          <AccountId>string</AccountId>
          <BeginDateTime d6p1:statusQualifier="string" xmlns:d6p1="http://www.docusign.net/API/3.0" />
          <EndDateTime>dateTime</EndDateTime>
          <Statuses>
            <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>
            <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>
          </Statuses>
          <EnvelopeIds>
            <EnvelopeId>string</EnvelopeId>
            <EnvelopeId>string</EnvelopeId>
          </EnvelopeIds>
          <StartAtIndex>nonNegativeInteger</StartAtIndex>
          <ACStatus>Unknown or Original or Transferred or AuthoritativeCopy or AuthoritativeCopyExportPending or AuthoritativeCopyExported or DepositPending or Deposited or DepositedEO or DepositFailed</ACStatus>
        </EnvelopeStatusFilter>
        <EnvelopeStatuses>
          <EnvelopeStatus>
            <RecipientStatuses xsi:nil="true" />
            <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 xsi:nil="true" />
            <VaultingDetails xsi:nil="true" />
            <AutoNavigation>boolean</AutoNavigation>
            <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
            <AuthoritativeCopy>boolean</AuthoritativeCopy>
            <EnvelopeAttachment xsi:nil="true" />
            <DocumentStatuses xsi:nil="true" />
            <FormData xsi:nil="true" />
            <VoidReason>string</VoidReason>
          </EnvelopeStatus>
          <EnvelopeStatus>
            <RecipientStatuses xsi:nil="true" />
            <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 xsi:nil="true" />
            <VaultingDetails xsi:nil="true" />
            <AutoNavigation>boolean</AutoNavigation>
            <EnvelopeIdStamping>boolean</EnvelopeIdStamping>
            <AuthoritativeCopy>boolean</AuthoritativeCopy>
            <EnvelopeAttachment xsi:nil="true" />
            <DocumentStatuses xsi:nil="true" />
            <FormData xsi:nil="true" />
            <VoidReason>string</VoidReason>
          </EnvelopeStatus>
        </EnvelopeStatuses>
      </RequestStatusesWithDocumentFieldsResult>
    </RequestStatusesWithDocumentFieldsResponse>
  </soap12:Body>
</soap12:Envelope>