(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_JsonToken
string ls_Url
oleobject loo_Bd
integer li_RespStatusCode
oleobject loo_Mime
string ls_Filename
oleobject loo_SbPath

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loo_JsonToken = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")

// Load a previously obtained OAuth2 access token.
li_Success = loo_JsonToken.LoadFile("qa_data/tokens/docusign.json")
if li_Success = 0 then
    Write-Debug loo_JsonToken.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    return
end if

loo_Http.AuthToken = loo_JsonToken.StringOf("access_token")

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

ls_Url = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents/1"
loo_Bd = create oleobject
// Use "Chilkat_9_5_0.BinData" for versions of Chilkat < 10.0.0
li_rc = loo_Bd.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_Http.DownloadBd(ls_Url,loo_Bd)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_Bd
    return
end if

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode <> 200 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastResponseHeader
    // The response body contains an error message.
    Write-Debug loo_Bd.GetString("utf-8")
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_JsonToken
    destroy loo_Bd
    return
end if

// The response indicated success.
// Get the filename from the Content-Disposition header and save to a file.
loo_Mime = create oleobject
// Use "Chilkat_9_5_0.Mime" for versions of Chilkat < 10.0.0
li_rc = loo_Mime.ConnectToNewObject("Chilkat.Mime")

loo_Mime.LoadMime(loo_Http.LastResponseHeader)

ls_Filename = loo_Mime.GetHeaderFieldAttribute("Content-Disposition","filename")
Write-Debug "filename = " + ls_Filename

loo_SbPath = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("C:/aaworkarea/")
loo_SbPath.Append(ls_Filename)
li_Success = loo_Bd.WriteFile(loo_SbPath.GetAsString())
if li_Success = 0 then
    Write-Debug "Failed to save to output file."
else
    Write-Debug "Wrote " + loo_SbPath.GetAsString()
end if



destroy loo_Http
destroy loo_JsonToken
destroy loo_Bd
destroy loo_Mime
destroy loo_SbPath