Geovisualization Developer's Guide

Georeference

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

Table 1. Georeference Response Elements
Element Data Type Description
created_at ISO Datetime The date and time at which the georeference 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 georeference job
kind String Type of response: the value is datalens#georeference_job when the request is successful, or datalens#georeferencing_result when the requested job has already been completed
id String The georeference job ID that can be used to retrieve the job's status
status String Status of the submitted georeferencing job.

Possible values include:

  • pending
  • running
  • completed
  • canceling
  • canceled
  • failed
updated_at ISO Datetime The date and time at which the georeference job was last updated, in ISO 8601 format with the Z indicating that the time is in UTC
msg String The message returned if the georeference job has already been completed successfully: "This job has already been run, georeferencing result can be found in the <column_name> column."

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

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