Get
Retrieve the current progress of your document
Parameters:
Name
Optional / Required
Data type
Description
Default
id
required
String
One of your document progress ids
Demo
URL Find your token on - yumpu.com Token
progress id
Run request
Example:
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/document/progress.json?id=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"Example:
require_once('../yumpu.php');
$yumpu = new Yumpu();
$progressId = 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX';
$documentProgess = $yumpu->getDocumentProgress($progressId);
print_r($documentProgess);Example:
var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
id: 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX'
};
yumpu.getdocumentProgress(parameters, function(statusCode, document){
console.log('Status: ' + statusCode);
console.log(document);
});Example:
Yumpu y = new Yumpu("your access token");
String[] params = {"id=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"};
System.out.println(y.getDocumentProgress(params));Whatever language you are using, the result will be the same.
Example 1:
{
"document": {
"state": "rendering_in_progress",
"message": "Magazine in rendering queue",
"imagecount": "84",
"progress": 0,
"images": 0
},
"state": "success"
}Example 2:
Last updated
Was this helpful?