Geovisualization Developer's Guide

Geocode

The geocode response body is a JSON object returned by the Geovisualization REST API in response to a request for a geocoding job.

Table 1. Geocode Response Elements
Element Data Type Description
created_at ISO Datetime The date and time at which the geocode job was created, in ISO 8601 format with the Z indicating that the time is in UTC
dataset String The ID of the dataset submitted to the geocoding job
kind String Type of response: the value is datalens#geocode_job when the request is successful
id String The geocode job ID that can be used to retrieve the job's status
status String Status of the submitted geocoding job.

Possible values include:

  • pending
  • running
  • completed
  • canceling
  • canceled
  • failed
updated_at ISO Datetime The date and time at which the geocode job was last updated, in ISO 8601 format with the Z indicating that the time is in UTC

The code example below illustrates a typical response to a successful geocoding request.

{
  "status": "pending",
  "kind": "datalens#geocode_job",
  "created_at": "2015-06-23T16:52:46Z",
  "updated_at": "2015-06-23T16:52:46Z",
  "dataset": "87354ed28a66441385942f62e94282ea",
  "id": "c0d0f18e3c184ffd9167e4ddc8bfe133"
}