University of Cape Town · Schema

DataFirst Catalog Study

A single survey/study row returned by the DataFirst NADA microdata catalog API.

EducationHigher EducationUniversityResearch DataOpen DataInstitutional RepositoryOAI-PMHSouth AfricaAfrica

Properties

Name Type Description
id integer Internal study identifier.
type string Study type (e.g. survey).
idno string Persistent study identifier.
doi stringnull DOI for the study, if assigned.
title string Study title.
subtitle string Study subtitle.
nation string Country the study covers.
authoring_entity string Producing institution(s).
form_model string Access model for the data (e.g. licensed, open).
data_class_id integernull
year_start integer First year covered by the study.
year_end integer Last year covered by the study.
thumbnail string Thumbnail image path or URL.
View JSON Schema on GitHub

JSON Schema

university-of-cape-town-study-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/university-of-cape-town/main/json-schema/university-of-cape-town-study-schema.json",
  "title": "DataFirst Catalog Study",
  "description": "A single survey/study row returned by the DataFirst NADA microdata catalog API.",
  "type": "object",
  "required": ["id", "type", "idno", "title"],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Internal study identifier."
    },
    "type": {
      "type": "string",
      "description": "Study type (e.g. survey)."
    },
    "idno": {
      "type": "string",
      "description": "Persistent study identifier."
    },
    "doi": {
      "type": ["string", "null"],
      "description": "DOI for the study, if assigned."
    },
    "title": {
      "type": "string",
      "description": "Study title."
    },
    "subtitle": {
      "type": "string",
      "description": "Study subtitle."
    },
    "nation": {
      "type": "string",
      "description": "Country the study covers."
    },
    "authoring_entity": {
      "type": "string",
      "description": "Producing institution(s)."
    },
    "form_model": {
      "type": "string",
      "description": "Access model for the data (e.g. licensed, open)."
    },
    "data_class_id": {
      "type": ["integer", "null"]
    },
    "year_start": {
      "type": "integer",
      "description": "First year covered by the study."
    },
    "year_end": {
      "type": "integer",
      "description": "Last year covered by the study."
    },
    "thumbnail": {
      "type": "string",
      "description": "Thumbnail image path or URL."
    }
  }
}