/datasets/{dataset_id}/editions/{edition}/versions/{version}/json

GET

Get observations for a census dataset, with capability to flex and filter the data to the users need. If no area-type parameters are supplied then observations for the default area-type are returned.

Parameters

Name Type Description
dataset_id path Id that represents a dataset
edition path An edition of a dataset
version path A version of a dataset
area-type query The name of the area-type dimension that is being flexed, e.g. country

Responses

200: Json object containing all metadata for a version

Example value
{
  "description": "An object containing information on a list of observations for a given version of a census dataset",
  "type": "object",
  "properties": {
    "dimensions": {
      "description": "A list of dimensions for the given query",
      "type": "array",
      "items": {
        "description": "Each element is a dimension and will represent a query parameter in the request unless the query parameter is equal to a wildcard value (*)",
        "type": "object",
        "properties": {
          "name": {
            "description": "The name of the dimension"
          },
          "options": {
            "type": "array",
            "items": {
              "properties": {
                "href": {
                  "description": "link to resource",
                  "type": "string"
                },
                "id": {
                  "description": "id of resource",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "links": {
      "description": "A list of links related to this observation resource",
      "type": "object",
      "properties": {
        "dataset_metadata": {
          "properties": {
            "href": {
              "description": "link to resource",
              "type": "string"
            },
            "id": {
              "description": "id of resource",
              "type": "string"
            }
          }
        },
        "self": {
          "properties": {
            "href": {
              "description": "link to resource",
              "type": "string"
            },
            "id": {
              "description": "id of resource",
              "type": "string"
            }
          }
        },
        "version": {
          "properties": {
            "href": {
              "description": "link to resource",
              "type": "string"
            },
            "id": {
              "description": "id of resource",
              "type": "string"
            }
          }
        }
      },
      "readOnly": true
    },
    "observations": {
      "description": "A list of observations found when filtering on query parameters",
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "total_observations": {
      "description": "The number of observations found",
      "type": "integer"
    }
  }
}

400: Invalid request, reasons can be one of the following: * query parameters contain incorrect dimensions

Example value
null

404: Resource not found, reasons can be one of the following: * dataset id was incorrect * edition was incorrect * version was incorrect * observations not found for selected query paramaters

Example value
null

500: Failed to process the request due to an internal error

Example value
null