Read the Progress of an Asynchronous Job
Find out what you can do with our API...
Read the percentage progress on an asynchronous job.
This is a free method.
API method to use: job_progress
Mandatory Parameters
| Name | Description |
|---|---|
| job_id | The ID of the job, as created by job_create. |
Returned Values
The XML response is contained within a <job_progress_res> element.
| Name | Description |
|---|---|
| status | Returns ok if the operation has succeeded, or error if an
error has occurred; Returns the error_code for error details. |
| error_code | Returns the error code when the status is error. See below for error codes. |
| t2a_version_number | The current API version number. |
| percentage |
The progress as an integer percentage. The job, or current stage of the job, is completed when the percentage is 100. |
Error Codes
See the common error codes. There are no errors which are specific to this method.
Example XML Response
<?xml version="1.0"?> <job_progress_res> <mode>normal</mode> <status>ok</status> <t2a_version_number>1.0.0</t2a_version_number> <percentage>17</percentage> </job_progress_res>