JavaScript

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. JavaScript

var success = false;

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

var http = new 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.
http.AuthToken = "YOUR_API_KEY";
http.SetRequestHeader("Content-Type","application/json");

var sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",sbResponseBody);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

console.log("Response Body:");
console.log(jResp.Emit());

var respStatusCode = http.LastStatus;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
    console.log("Response Header:");
    console.log(http.LastHeader);
    console.log("Failed.");
    return;
}

// 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

var id = jResp.StringOf("id");
var name = jResp.StringOf("name");
var v_type = jResp.StringOf("type");
var contentType = jResp.StringOf("contentType");
var description = jResp.StringOf("description");
var createdAt = jResp.StringOf("createdAt");
var updatedAt = jResp.StringOf("updatedAt");
var sha256 = jResp.StringOf("sha256");
var workspace = jResp.StringOf("workspace");
var creator = jResp.StringOf("creator");
var v_protected = jResp.BoolOf("protected");
var position = jResp.IntOf("position");
var parent = jResp.StringOf("parent");
var i = 0;
var count_i = jResp.SizeOfArray("metadata");
while (i < count_i) {
    jResp.I = i;
    i = i+1;
}