Batch job start

Once a batch job has successfully been imported and configured, it can be started. The batch job will be started by the request-Id or the user-defined name with the action start.

A batch job can consists of three different tasks:

- Geocoding of addresses (geocoding)

- Assigning customer addresses to destination addresses (routing)

- Creation of the maps (map_creation)

GEOcoding and Routing:

action=start

HTTP-GET-Call

https://maps1.locr.com/batch-processing/job_v2.php?action=start&requestid=<id>&to_dos=geocoding,routing

The individual jobs must be performed in the right order. This can be done by individual batch jobs sequentially or with a common batch job.

Parameter:

to_dos=<>

    • geocoding

    • routing

    • Combination from the first 3 parameter, separated by comma: geocoding,routing

Maps Creation:

There is an additional parameter for the map creation for a free of charge 20-maps-test:

action=start_test_run

to_dos=<>

    • map_creation

To start the complete map production use the "action=start" with parameter "map_creation". The start of a map production is chargeable! The maps licenses will be taken from the user's pre-bought maps package!

To confirm this through the API, the first call of the URL with the parameter "map_creation" returns a token. This Token must be passed with a renewed call!

Start HTTP-GET-Call:

https://maps1.locr.com/batch-processing/job.php?action=start&requestid=<id>&to_dos=map_creation

Sample for URL response:

<BatchProcessing>

<Response>

<MetaInfo>

<RequestId>4fec2eb23a16880b77000000</RequestId>

<Name>jobname</Name>

<Created>2012-06-01 12:00:00</Created>

</MetaInfo>

<TokenRequired>12345678901234567890</TokenRequired>

</Response>

</BatchProcessing>

Token: 12345678901234567890

HTTP-GET URL to start complete maps production:

https://maps1.locr.com/batch-processing/job.php?action=start&requestid=<id>&to_dos=map_creation&token=12345678901234567890

Note:

By using area maps (locr LOCALmaps) the second step "routing" is not possible

Example 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>running</Status>

<Geocoding>

<Customers>

<TotalCount>1</TotalCount>

<ProcessedCount>0</ProcessedCount>

<ValidCount>0</ValidCount>

<InvalidCount>0</InvalidCount>

</Customers>

<Shops>

<TotalCount>1</TotalCount>

<ProcessedCount>0</ProcessedCount>

<ValidCount>0</ValidCount>

<InvalidCount>0</InvalidCount>

</Shops>

</Geocoding>

<Routing>

<TotalCount>0</TotalCount>

<ProcessedCount>0</ProcessedCount>

<ValidCount>0</ValidCount>

<InvalidCount>0</InvalidCount>

</Routing>

</Response>

</BatchProcessing>