Bulk Geo Addressing

Checks status of requested job of bulk geocode/verify

This API checks status of requested job of bulk geocode/verify. It takes the job id provided when we submit bulk geocode/verify job and returns the status of the job. Once the job is completed it returns download url of output file along with status.

get/v1/bulk/jobs/{jobId}

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/bulk/jobs/{jobId}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

jobIdstring required

job id of bulk geocode or verify

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting.

Response

Status got successfully

status'SCHEDULED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'REJECTED' required

status of the job

downloadUrlstring url

url for downloading the output file of the Bulk Geocode/Verify

reportUrlstring url

url for downloading the report file of the Bulk Geocode/Verify

messagestring

message for the response

errorstring

Error message of the Job

Example response

{
  "status": "RUNNING",
  "downloadUrl": "https://us-east-1-bulk-api.s3.us-east-1.amazonaws.com/test/test_user_1%40precisely.com/output/91ff044f-cc42-4c8a-a781-43fdc4a14963/test_file%3A%3A16bb27b6-9f71-4bf2-8c34-19d4a7b6a035.csv",
  "reportUrl": "https://us-east-1-bulk-api.s3.us-east-1.amazonaws.com/test/test_user_1%40precisely.com/output/91ff044f-cc42-4c8a-a781-43fdc4a14963/cass3553.csv",
  "message": "This download URL will be valid for the next 10 mins.",
  "error": "Invalid Job Id (DIS-LI-1051)"
}

Changes

No recorded changes to this operation across all 1 revision of this API.