PUT Async Batch Job Stop enterprise only
The batch job stop service allows you to stop a batch geocoding job that is currently running or queued. This will halt processing and change the job status to stopped.
Resource URL
https://www.mapquestapi.com/geocoding/v1/batch/jobs/{jobId}/stop
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 "stopped") |
| 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/stop?key=YOUR_API_KEY"Example Response
json
{
"id": "abc123-def456-ghi789",
"status": "stopped",
"href": "https://www.mapquestapi.com/geocoding/v1/batch/jobs/abc123-def456-ghi789"
}Important Notes
- HTTP Method: PUT request to stop 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 running or queued jobs can be stopped
- Status Change: Stopping a job will change its status to "stopped"
- Response Format: Returns JSON with job metadata