Batch job state
With the action status and the request-Id or batch-job-name it is possible to monitoring the batch-job process:
action=status
Example:
https://maps1.locr.com/batch-processing/status.php?action=status&name=<jobname>
Additional parameter:
to_dos=<parameter>
geocoding - Information for geocoding
routing - Information for routing
map_creation - Information for map generation
https://maps1.locr.com/batch-processing/job_v2.php?action=status&name=<jobname>&to_dos=geocoding
https://maps1.locr.com/batch-processing/job_v2.php?action=status&name=<jobname>&to_dos=routing
https://maps1.locr.com/batch-processing/job_v2.php?action=status&name=<jobname>&to_dos=map_creation
Return states for the project:
importing - Import is in process.
submitted - Import completed.
pending - Project task is in starting process.
running - Project task is running.
cancelling - Project was cancelled, waiting for running processes to be completed.
cancelled - A project task was cancelled.
auto_cancelled - A project task was killed from the internal system.
reset_completed - An interrupted or finished project was reset.
completed_geocoding - Geocoding task is completed.
completed_routing - Routing task is completed.
completed - All Project tasks are completed.
deleted - Return value after the deleting command.
Return states for the geocoding, routing and map creation:
not_started - Initial value, ready to start the task.
invalidated - Changing settings from a interupted project.
pending - Project task is in starting process.
running - Project task is running.
cancelling - Geocoding, routing or map creation was cancelled and waiting for running processes to be completed.
cancelled - Geocoding, routing or map creation was cancelled.
auto_cancelled - Geocoding, routing or map creation was killed from the internal system.
reset_completed - Geocoding or routing of interupted or finished project was reset.
completed - Project task is completed.
Sample return:
<?xml version="1.0" encoding="utf-8"?>
<BatchProcessing>
<Response>
<MetaInfo>
<RequestId>4fec2eb23a16880b77000000</RequestId>
<Name>jobname</Name>
<Created>2012-06-01 12:00:00</Created>
</MetaInfo>
<Status>completed</Status>
<Statuses>
<Geocoding>
<Customers>completed</Customers>
<Shops>completed</Shops>
</Geocoding>
<Routing>running</Routing>
</Statuses>
<Geocoding>
<Customers>
<TotalCount>1</TotalCount>
<ProcessedCount>1</ProcessedCount>
<ValidCount>1</ValidCount>
<InvalidCount>0</InvalidCount>
</Customers>
<Shops>
<TotalCount>1</TotalCount>
<ProcessedCount>1</ProcessedCount>
<ValidCount>1</ValidCount>
<InvalidCount>0</InvalidCount>
</Shops>
</Geocoding>
</Response>
</BatchProcessing>