APIService

Click here for a complete list of operations.

RequestPDFWithOptions

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

<?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>
    <RequestPDFWithOptions xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
      <PDFOptions>
        <ShowChanges>boolean</ShowChanges>
        <AddWaterMark>boolean</AddWaterMark>
        <IncludeCert>boolean</IncludeCert>
        <CertificateLanguage>string</CertificateLanguage>
      </PDFOptions>
    </RequestPDFWithOptions>
  </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>
    <RequestPDFWithOptionsResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestPDFWithOptionsResult>
        <EnvelopeID>string</EnvelopeID>
        <PDFBytes>base64Binary</PDFBytes>
      </RequestPDFWithOptionsResult>
    </RequestPDFWithOptionsResponse>
  </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>
    <RequestPDFWithOptions xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
      <PDFOptions>
        <ShowChanges>boolean</ShowChanges>
        <AddWaterMark>boolean</AddWaterMark>
        <IncludeCert>boolean</IncludeCert>
        <CertificateLanguage>string</CertificateLanguage>
      </PDFOptions>
    </RequestPDFWithOptions>
  </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>
    <RequestPDFWithOptionsResponse xmlns="http://www.docusign.net/API/3.0">
      <RequestPDFWithOptionsResult>
        <EnvelopeID>string</EnvelopeID>
        <PDFBytes>base64Binary</PDFBytes>
      </RequestPDFWithOptionsResult>
    </RequestPDFWithOptionsResponse>
  </soap12:Body>
</soap12:Envelope>