Visual FoxPro

Yousign: Download Information about Previously Uploaded File

See more Yousign Examples

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

LOCAL lnSuccess
LOCAL loHttp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcName
LOCAL lcV_type
LOCAL lcContentType
LOCAL lcDescription
LOCAL lcCreatedAt
LOCAL lcUpdatedAt
LOCAL lcSha256
LOCAL lcWorkspace
LOCAL lcCreator
LOCAL lnV_protected
LOCAL lnPosition
LOCAL lcParent
LOCAL i
LOCAL lnCount_i

lnSuccess = 0

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

loHttp = CreateObject('Chilkat.Http')

* 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('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
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")
lnV_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