(Swift 3,4,5...) DocuSign Add One Document to a Draft Envelope

See more DocuSign Examples

Demonstrates how to add one document to a DocuSign draft envelope.

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

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let http = CkoHttp()!

    // Load a previously obtained OAuth2 access token.
    let jsonToken = CkoJsonObject()!
    var success: Bool = jsonToken.loadFile("qa_data/tokens/docusign.json")
    if success == false {
        print("\(jsonToken.lastErrorText!)")
        return
    }

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    http.authToken = jsonToken.string(of: "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>/documents HTTP/1.1
    // Expect: 100-continue
    // Accept: application/json
    // Cache-Control: no-cache
    // Authorization: Bearer eyJ0eX...
    // Content-Length: ...
    // Content-Type: application/json
    // 
    // {
    // 	"documents": [
    // 		{
    // 		"documentId": "1",
    // 		"name": "project_xyz.pdf",
    // 		"pages": "1",
    // 		"documentBase64": "<insert base64 content here>"
    // 		}
    // 	]
    // }

    let bd1 = CkoBinData()!
    success = bd1.loadFile("qa_data/pdf/project_xyz.pdf")

    let json = CkoJsonObject()!
    json.update("documents[0].documentId", value: "1")
    json.update("documents[0].name", value: "project_xyz.pdf")
    json.update("documents[0].pages", value: "1")
    json.update("documents[0].documentBase64", value: bd1.getEncoded("base64"))

    let sbJson = CkoStringBuilder()!
    json.emitCompact = false
    json.emitSb(sbJson)

    http.setRequestHeader("Expect", value: "100-continue")
    http.setRequestHeader("Cache-Control", value: "no-cache")
    http.setRequestHeader("Accept", value: "application/json")

    // Use your own account ID here.
    http.setUrlVar("accountId", value: "7f3f65ed-5e87-418d-94c1-92499ddc8252")
    // Use the envelope ID returned by DocuSign when creating the draft envelope).
    http.setUrlVar("envelopeId", value: "0b437b95-cc50-475f-8dec-65bae9f27d09")

    var url: String? = "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents"
    var resp: CkoHttpResponse? = http.pTextSb("PUT", url: url, textData: sbJson, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.load(resp!.bodyStr)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    // If you get a 401 response status code, it's likely you need to refresh the DocuSign OAuth2 token).
    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "envelopeId": "da9fb811-e6a4-48c0-a9fb-81ed18b989af",
    //   "envelopeDocuments": [
    //     {
    //       "documentId": "1",
    //       "documentIdGuid": "38e919fc-0a77-4b0c-9da0-e3530f4e6fc7",
    //       "name": "project_xyz.pdf",
    //       "type": "content",
    //       "uri": "/envelopes/da9fb811-e6a4-48c0-a9fb-81ed18b989af/documents/1",
    //       "order": "3",
    //       "containsPdfFormFields": "false",
    //       "templateRequired": "false",
    //       "authoritativeCopy": "false"
    //     }
    //   ]
    // }

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

    var documentId: String?
    var documentIdGuid: String?
    var name: String?
    var v_type: String?
    var uri: String?
    var order: String?
    var containsPdfFormFields: String?
    var templateRequired: String?
    var authoritativeCopy: String?

    var envelopeId: String? = jResp.string(of: "envelopeId")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "envelopeDocuments").intValue
    while i < count_i {
        jResp.i = i
        documentId = jResp.string(of: "envelopeDocuments[i].documentId")
        documentIdGuid = jResp.string(of: "envelopeDocuments[i].documentIdGuid")
        name = jResp.string(of: "envelopeDocuments[i].name")
        v_type = jResp.string(of: "envelopeDocuments[i].type")
        uri = jResp.string(of: "envelopeDocuments[i].uri")
        order = jResp.string(of: "envelopeDocuments[i].order")
        containsPdfFormFields = jResp.string(of: "envelopeDocuments[i].containsPdfFormFields")
        templateRequired = jResp.string(of: "envelopeDocuments[i].templateRequired")
        authoritativeCopy = jResp.string(of: "envelopeDocuments[i].authoritativeCopy")
        i = i + 1
    }


}