Batch Geocoder API Developer's Guide

Job Status

After a job has been submitted the job status can be checked with a GET request and parameter action=status. The job status can be one of: submitted, accepted, running, completed, cancelled, deleted, or failed.

Job submitted and accepted

Status = accepted.

All counts are still 0.

A job can also be submitted via POST (upload of the input data) without starting it right away.

To do this do not specify the parameter action=run. The status in this case is submitted. Start the job later with a PUT request and action=run.

Job started running

Status = running.

JobStatus shows start time.

Counts may show 0 at first but will show counts as soon as first records are processed.

Job is still running

Status = running.

JobStatus shows start time.

Counts now reflect job progress.

Job is running and nearly done

Status = running.

Counts show all records have been processed, i.e. total count = processed count.

Results are being sorted and results ZIP file is being created.

Job is completed

Status = completed.

JobFinished shows time when job has completed.

Counts show stats for job.

Files of job are ready for download.

Job is cancelled

Status = cancelled.

Job was cancelled by user with HTTP PUT command action=cancel.

Counts show stats for job at time of cancellation. Job results are not available for download.

Job is deleted

Status = deleted.

Job was deleted by user with HTTP DELETE command.

Counts show stats for job at time of deletion. Job results are not available for download anymore.

Files are removed from the Geocoder's systems. Note: Jobs are automatically removed from the server 30 days after they are processed.

Job failed

Status = failed.

Job failed while running. This is unusual and caused by an internal error. You can try to restart the job with a PUT request and action=run or delete the job.