APIService Web Service

APIService

Click here for a complete list of operations.

GetFolderItems

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/GetFolderItems"

<?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>
    <GetFolderItems xmlns="http://www.docusign.net/API/3.0">
      <FolderFilter>
        <AccountId>string</AccountId>
        <FolderOwner>
          <UserName>string</UserName>
          <Email>string</Email>
        </FolderOwner>
        <FolderTypeInfo>
          <FolderType>RecycleBin or Draft or Inbox or SentItems or Normal</FolderType>
          <FolderName>string</FolderName>
          <FolderPath>string</FolderPath>
          <FolderId>string</FolderId>
        </FolderTypeInfo>
        <StartPosition>int</StartPosition>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <SearchText>string</SearchText>
        <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>
      </FolderFilter>
    </GetFolderItems>
  </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>
    <GetFolderItemsResponse xmlns="http://www.docusign.net/API/3.0">
      <GetFolderItemsResult>
        <ResultSetSize>int</ResultSetSize>
        <StartPosition>int</StartPosition>
        <EndPosition>int</EndPosition>
        <FolderTypeInfo>
          <FolderType>RecycleBin or Draft or Inbox or SentItems or Normal</FolderType>
          <FolderName>string</FolderName>
          <FolderPath>string</FolderPath>
          <FolderId>string</FolderId>
        </FolderTypeInfo>
        <FolderItems>
          <FolderItem>
            <EnvelopeId>string</EnvelopeId>
            <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>
            <Owner>string</Owner>
            <SenderName>string</SenderName>
            <SenderEmail>string</SenderEmail>
            <SenderCompany>string</SenderCompany>
            <RecipientStatuses xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <Created>dateTime</Created>
            <Sent>dateTime</Sent>
            <Completed>dateTime</Completed>
            <Subject>string</Subject>
          </FolderItem>
          <FolderItem>
            <EnvelopeId>string</EnvelopeId>
            <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>
            <Owner>string</Owner>
            <SenderName>string</SenderName>
            <SenderEmail>string</SenderEmail>
            <SenderCompany>string</SenderCompany>
            <RecipientStatuses xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <Created>dateTime</Created>
            <Sent>dateTime</Sent>
            <Completed>dateTime</Completed>
            <Subject>string</Subject>
          </FolderItem>
        </FolderItems>
      </GetFolderItemsResult>
    </GetFolderItemsResponse>
  </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>
    <GetFolderItems xmlns="http://www.docusign.net/API/3.0">
      <FolderFilter>
        <AccountId>string</AccountId>
        <FolderOwner>
          <UserName>string</UserName>
          <Email>string</Email>
        </FolderOwner>
        <FolderTypeInfo>
          <FolderType>RecycleBin or Draft or Inbox or SentItems or Normal</FolderType>
          <FolderName>string</FolderName>
          <FolderPath>string</FolderPath>
          <FolderId>string</FolderId>
        </FolderTypeInfo>
        <StartPosition>int</StartPosition>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <SearchText>string</SearchText>
        <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>
      </FolderFilter>
    </GetFolderItems>
  </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>
    <GetFolderItemsResponse xmlns="http://www.docusign.net/API/3.0">
      <GetFolderItemsResult>
        <ResultSetSize>int</ResultSetSize>
        <StartPosition>int</StartPosition>
        <EndPosition>int</EndPosition>
        <FolderTypeInfo>
          <FolderType>RecycleBin or Draft or Inbox or SentItems or Normal</FolderType>
          <FolderName>string</FolderName>
          <FolderPath>string</FolderPath>
          <FolderId>string</FolderId>
        </FolderTypeInfo>
        <FolderItems>
          <FolderItem>
            <EnvelopeId>string</EnvelopeId>
            <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>
            <Owner>string</Owner>
            <SenderName>string</SenderName>
            <SenderEmail>string</SenderEmail>
            <SenderCompany>string</SenderCompany>
            <RecipientStatuses xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <Created>dateTime</Created>
            <Sent>dateTime</Sent>
            <Completed>dateTime</Completed>
            <Subject>string</Subject>
          </FolderItem>
          <FolderItem>
            <EnvelopeId>string</EnvelopeId>
            <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>
            <Owner>string</Owner>
            <SenderName>string</SenderName>
            <SenderEmail>string</SenderEmail>
            <SenderCompany>string</SenderCompany>
            <RecipientStatuses xsi:nil="true" />
            <CustomFields xsi:nil="true" />
            <Created>dateTime</Created>
            <Sent>dateTime</Sent>
            <Completed>dateTime</Completed>
            <Subject>string</Subject>
          </FolderItem>
        </FolderItems>
      </GetFolderItemsResult>
    </GetFolderItemsResponse>
  </soap12:Body>
</soap12:Envelope>