PUT Async Batch Job Start enterprise only
The batch job start service allows you to start a batch geocoding job that was created with startJob=false
or has been stopped. This will begin processing the job and change its status to queued
.
Resource URL
https://www.mapquestapi.com/geocoding/v1/batch/jobs/{jobId}/start
Resource Information
Response Formats | JSON |
Authentication | Yes (Requires Key) |
Rate Limited | Yes |
Request Parameters
Request Parameter | Description | Required |
---|---|---|
key | The API Key, which is needed to make requests to MapQuest services. | Yes |
Note: The jobId
is specified in the URL path, not as a query parameter.
Response Object
id | The unique job identifier |
status | The updated job status (typically "queued") |
href | The MapQuest URL of the job details |
Example Request
bash
curl -X PUT "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789/start?key=YOUR_API_KEY"
Example Response
json
{
"id": "abc123-def456-ghi789",
"status": "queued",
"href": "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789"
}
Important Notes
- HTTP Method: PUT request to start the job
- Authentication: Same API key as other endpoints, passed as query parameter
- Job ID: The job ID is passed in the URL path, not as a query parameter
- Job State: Only jobs that are not already running can be started
- Status Change: Starting a job will typically change its status to "queued"
- Response Format: Returns JSON with job metadata