(Lianja) Yousign: Download Information about Previously Uploaded File

Demonstrates how to download the information (in JSON format) about a file previously uploaded.

For more information, see https://dev.yousign.com/?version=latest#26513de1-9fab-44d5-96b1-70fe3b3de7a7

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// Implements the following CURL command:

// curl --location --request GET 'https://staging-api.yousign.com/files/{{id}}' \
// --header 'Authorization: Bearer YOUR_API_KEY' \
// --header 'Content-Type: application/json'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// Adds the "Authorization: Bearer YOUR_API_KEY" header.
loHttp.AuthToken = "YOUR_API_KEY"
loHttp.SetRequestHeader("Content-Type","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

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

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

// {
//   "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "name": "The best name for my file.pdf",
//   "type": "signable",
//   "contentType": "application/pdf",
//   "description": null,
//   "createdAt": "2018-12-07T08:10:21+01:00",
//   "updatedAt": "2018-12-07T08:10:21+01:00",
//   "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
//   "metadata": [
//   ],
//   "workspace": "/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "creator": null,
//   "protected": false,
//   "position": 0,
//   "parent": null
// }

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

lcId = loJResp.StringOf("id")
lcName = loJResp.StringOf("name")
lcV_type = loJResp.StringOf("type")
lcContentType = loJResp.StringOf("contentType")
lcDescription = loJResp.StringOf("description")
lcCreatedAt = loJResp.StringOf("createdAt")
lcUpdatedAt = loJResp.StringOf("updatedAt")
lcSha256 = loJResp.StringOf("sha256")
lcWorkspace = loJResp.StringOf("workspace")
lcCreator = loJResp.StringOf("creator")
llV_protected = loJResp.BoolOf("protected")
lnPosition = loJResp.IntOf("position")
lcParent = loJResp.StringOf("parent")
i = 0
lnCount_i = loJResp.SizeOfArray("metadata")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp