(VB.NET) DocuSign Download Envelope Document (PDF)

See more DocuSign Examples

Retrieves the specified document from the envelope. The response body of this method is the PDF file as a byte stream. You can get the file name and document ID from the response's Content-Disposition header.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' Implements the following HTTP request:
' GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/1

' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
Dim jsonToken As New Chilkat.JsonObject
' Load a previously obtained OAuth2 access token.
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = False) Then
    Debug.WriteLine(jsonToken.LastErrorText)
    Exit Sub
End If


http.AuthToken = jsonToken.StringOf("access_token")

' Use your account ID and a valid envelopeId here:
http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
http.SetUrlVar("envelopeId","90d7e40a-b4bd-4ccd-bf38-c80e37954a13")

Dim url As String = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents/1"
Dim bd As New Chilkat.BinData

success = http.DownloadBd(url,bd)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode <> 200) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastResponseHeader)
    ' The response body contains an error message.
    Debug.WriteLine(bd.GetString("utf-8"))
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' The response indicated success.
' Get the filename from the Content-Disposition header and save to a file.
Dim mime As New Chilkat.Mime
mime.LoadMime(http.LastResponseHeader)

Dim filename As String = mime.GetHeaderFieldAttribute("Content-Disposition","filename")
Debug.WriteLine("filename = " & filename)

Dim sbPath As New Chilkat.StringBuilder
sbPath.Append("C:/aaworkarea/")
sbPath.Append(filename)
success = bd.WriteFile(sbPath.GetAsString())
If (success = False) Then
    Debug.WriteLine("Failed to save to output file.")
Else
    Debug.WriteLine("Wrote " & sbPath.GetAsString())
End If