Technical University of Munich · JSON Structure

Tum Search Response Structure

Structure of the NavigaTUM /api/search response.

Type: object Properties: 2 Required: 2
EducationHigher EducationUniversityGermanyOpen SourceCampusOpen Data

SearchResponse is a JSON Structure definition published by Technical University of Munich, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0 meta-schema.

Properties

sections time_ms

Meta-schema: https://json-structure.org/meta/core/v0

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tum/main/json-structure/tum-search-response-structure.json",
  "name": "SearchResponse",
  "description": "Structure of the NavigaTUM /api/search response.",
  "type": "object",
  "properties": {
    "sections": {
      "type": "array",
      "items": {
        "type": "object",
        "name": "ResultsSection",
        "properties": {
          "facet": { "type": "string" },
          "n_visible": { "type": "int32" },
          "estimatedTotalHits": { "type": "int32" },
          "entries": {
            "type": "array",
            "items": {
              "type": "object",
              "name": "ResultEntry",
              "properties": {
                "id": { "type": "string" },
                "type": { "type": "string" },
                "name": { "type": "string" },
                "subtext": { "type": "string" },
                "parsed_id": { "type": ["string", "null"] }
              },
              "required": ["id", "type", "name", "subtext"]
            }
          }
        },
        "required": ["facet", "entries", "n_visible", "estimatedTotalHits"]
      }
    },
    "time_ms": { "type": "int32" }
  },
  "required": ["sections", "time_ms"]
}