(Visual FoxPro) DocuSign Send a Draft Envelope

See more DocuSign Examples

Demonstrates how to send a DocuSign draft envelope.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbJson
LOCAL lcUrl
LOCAL loResp
LOCAL loJResp
LOCAL lnRespStatusCode

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Load a previously obtained OAuth2 access token.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/docusign.json")
IF (lnSuccess = 0) THEN
    ? loJsonToken.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    CANCEL
ENDIF

* Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
loHttp.AuthToken = loJsonToken.StringOf("access_token")

* Send the following request.
* Make sure to use your own account ID (obtained from Get Docusign User Account Information)

* PUT https://demo.docusign.net/restapi/v2.1/accounts/<account ID>/envelopes/<envelope ID> HTTP/1.1
* Accept: application/json
* Cache-Control: no-cache
* Authorization: Bearer eyJ0eX...
* Content-Length: ...
* Content-Type: application/json
* 
* {
*   "status": "sent"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("status","sent")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbJson = CreateObject('Chilkat.StringBuilder')
loJson.EmitCompact = 0
loJson.EmitSb(loSbJson)

loHttp.SetRequestHeader("Cache-Control","no-cache")
loHttp.SetRequestHeader("Accept","application/json")

* Use your own account ID here.
loHttp.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
* Use the envelope ID returned by DocuSign when creating the draft envelope).
loHttp.SetUrlVar("envelopeId","cee4191c-f94e-4089-9d7c-8033685cbc1a")

lcUrl = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}"
loResp = loHttp.PTextSb("PUT",lcUrl,loSbJson,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loJson
    RELEASE loSbJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.Load(loResp.BodyStr)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

* If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJsonToken
    RELEASE loJson
    RELEASE loSbJson
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)

* If the envelope you're trying to send is not yet completed, you'll get an error such as this:
* {
*   "errorCode": "ENVELOPE_IS_INCOMPLETE",
*   "message": "The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line."
* }

* Sample code for parsing the JSON response...
* Use the following online tool to generate parsing code from sample JSON:
* Generate Parsing Code from JSON

RELEASE loHttp
RELEASE loJsonToken
RELEASE loJson
RELEASE loSbJson
RELEASE loJResp