Rice Kinder Institute Urban Data Platform — Dataset

{
  "x-provenance": {
    "generated": "2026-09-01",
    "method": "derived",
    "source": "Derived from the live probed responses archived in examples/rice-kinder-udp-datasets-example.json and examples/rice-kinder-udp-dataset-detail-example.json. Enumerations are taken verbatim from the platform's own /lookups endpoint, not invented.",
    "operator": "institution",
    "authorship": "This artifact was generated by API Evangelist from live public probes on 2026-09-01. It is not published by Rice University and Rice did not author it."
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/rice/refs/heads/main/json-schema/rice-kinder-udp-dataset-schema.json",
  "title": "Rice Kinder Institute Urban Data Platform — Dataset",
  "description": "Schema for a dataset record served by the Kinder Institute Urban Data Platform API at https://lg4tooqkr1.execute-api.us-east-1.amazonaws.com/prod/. Derived from 431 live catalog records and one detail record probed on 2026-09-01. Rice publishes no schema for this API; this document describes observed structure, not a published contract.",
  "type": "object",
  "required": [
    "id",
    "udpName",
    "category",
    "accessRestriction",
    "status",
    "isInUdp"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9]{12}$",
      "description": "Opaque catalog identifier."
    },
    "udpName": {
      "type": "string",
      "description": "Dataset title as curated by the platform."
    },
    "shortDescription": {
      "type": [
        "string",
        "null"
      ]
    },
    "fullDescription": {
      "type": [
        "string",
        "null"
      ],
      "description": "Prose that may contain HTML <br> markup."
    },
    "accessRestriction": {
      "type": "string",
      "enum": [
        "Available to all members",
        "Available to Affiliated Users Only",
        "Authorization required"
      ],
      "description": "From the platform's accessRestriction lookup."
    },
    "status": {
      "type": "string",
      "enum": [
        "Being considered",
        "Waiting for regulatory documents",
        "Regulatory documents approved or not needed",
        "Raw dataset",
        "Curation in process",
        "Validation in process",
        "UDP curated dataset",
        "Contributor curated dataset"
      ],
      "description": "Curation state, from the platform's status lookup."
    },
    "source": {
      "type": [
        "string",
        "null"
      ],
      "description": "Originating data provider, e.g. TCEQ, Census Bureau, BLS."
    },
    "category": {
      "type": "string",
      "enum": [
        "Census/ACS",
        "Crime",
        "Economy",
        "Education",
        "Environment",
        "Health",
        "Housing",
        "Infrastructure",
        "Surveys",
        "Land Use",
        "Other",
        "Reference",
        "Resources",
        "Tax Assessor"
      ]
    },
    "keywords": {
      "type": [
        "string",
        "null"
      ],
      "description": "Semicolon-delimited keyword string. Not an array — clients must split on ';'."
    },
    "isGeocoded": {
      "type": "boolean"
    },
    "isDownloadable": {
      "type": "boolean"
    },
    "isInUdp": {
      "type": "boolean",
      "description": "Whether the data itself is loaded into the platform, as opposed to being catalog-only."
    },
    "isInGdb": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "isHiddenFromPublic": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "geoExtent": {
      "type": [
        "string",
        "null"
      ],
      "description": "Geographic coverage; 27-term controlled vocabulary."
    },
    "geoResolution": {
      "type": [
        "string",
        "null"
      ],
      "description": "21-term controlled vocabulary."
    },
    "tabularResolution": {
      "type": [
        "string",
        "null"
      ],
      "description": "38-term controlled vocabulary, e.g. 'monitoring station per hour'."
    },
    "earliestDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "latestDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "specificYears": {
      "type": [
        "string",
        "null"
      ]
    },
    "releaseDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "released": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastModifiedDatetime": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Epoch milliseconds."
    },
    "updateFreq": {
      "type": [
        "string",
        "null"
      ],
      "description": "14-term controlled vocabulary, e.g. 'Every 2 years'."
    },
    "versionNo": {
      "type": [
        "string",
        "null"
      ]
    },
    "doi": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^10\\.\\d{4,9}/.+$",
      "description": "DataCite DOI. Observed values sit under prefix 10.25612, registered to DataCite client RICE.KINDER ('Kinder Institute Urban Data Platform') under DataCite member 'rice' (Fondren Library, Rice University).",
      "examples": [
        "10.25612/837.16MO4PKRWM20",
        "10.25612/837.n819ov8mkovz"
      ]
    },
    "dataciteName": {
      "type": [
        "string",
        "null"
      ]
    },
    "originalDataCitation": {
      "type": [
        "string",
        "null"
      ]
    },
    "paperCitation": {
      "type": [
        "string",
        "null"
      ]
    },
    "suggestedCitation": {
      "type": [
        "string",
        "null"
      ],
      "description": "Citation string naming the publisher; observed values name 'Rice University-Kinder Institute: UDP'."
    },
    "relatedDatasets": {
      "type": "array",
      "description": "Typed relations to other catalog datasets, using DataCite RelationType terms.",
      "items": {
        "type": "object",
        "required": [
          "relationType",
          "id"
        ],
        "properties": {
          "relationType": {
            "type": "string",
            "enum": [
              "IsNewVersionOf",
              "IsPreviousVersionOf",
              "IsSupplementTo",
              "IsSupplementedBy",
              "IsCitedBy",
              "Cites",
              "IsContinuedBy",
              "Continues",
              "HasMetadata",
              "IsMetadataFor",
              "IsPartOf",
              "HasPart",
              "IsReferencedBy",
              "References",
              "IsDocumentedBy",
              "Documents",
              "IsCompiledBy",
              "Compiles",
              "IsVariantFormOf",
              "IsOriginalFormOf",
              "IsIdenticalTo",
              "IsReviewedBy",
              "Reviews",
              "IsDerivedFrom",
              "IsSourceOf",
              "Obsoletes",
              "IsObsoletedBy"
            ]
          },
          "id": {
            "type": "string",
            "pattern": "^[a-z0-9]{12}$"
          }
        }
      }
    },
    "folderPathMulti": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only on /datasets/{id}/vrde. Mount path inside the Kinder Institute's Virtual Research Data Environment."
    }
  }
}