Sign up Login

Read the Progress of an Asynchronous Job

API Method: job_progress

Description

Read the percentage progress on an asynchronous job.

This is a free method.

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>3.0.5.8</t2a_version_number>
  <percentage>17</percentage>
</job_progress_res>

Looking for the old documentation? Download it here (PDF format)

API Method List

< Back to T2A API Documentation

  1. Search for a person (person_search)
  2. Find people at an address (address_person)
  3. Search the UK Electoral Roll (electoral_roll)
  4. Search the Full UK Electoral Roll (full_electoral_roll)
  5. Search for a residential telephone number (telephone_residential)
  6. Search for a business (business_search)
  7. Search for an address/postcode (address_search)
  8. Validate a telephone number (validate_telephone)
  9. Validate a credit card number (validate_credit_card)
  10. Validate an email address (validate_email)
  11. Validate a VAT number (validate_vat)
  12. TPS/CTPS check a telephone number (tps_full)
  13. Find UK dialling codes (area_code)
  14. Find international dialling codes (country_dial)
  15. Geo-Code an address (geo_code)
  16. Reverse Geo-Code (reverse_geo_code)
  17. Find company details (company_details)
  18. Find director details (director_details)
  19. Get a company credit report (company_credit_report)
  20. Find a location from an IP address (ip_location)
  21. Send a text message (send_text_message)
  22. Check the bereavement register (deceased)
  23. Bulk check the bereavement register (deceased_bulk)
  24. Check company name availability (company_name_check)
  25. Download a company document (company_document_download)
  26. Generate a secure JavaScript key (javascript_key)
  27. Create an asynchronous job (job_create)
  28. Read the progress of an asynchronous job (job_progress)
  29. Telephone number appending (tele_append)
  30. Validate a person (validate_person)
  31. View information about your account (client_info)