Open Education API · Schema

NewsItem

A newsitem contains the message and metadata of that message

CompanyEducationHigher EducationOpen StandardInteroperabilitySpecificationNetherlands

Properties

Name Type Description
newsItemId string Unique id for this news item
newsItemType object
name array The name for this news item
authors array The authors of the article with this news item
image string The url containing the address of the image belonging to this news item
link string The url containing the address of the article belonging to this news item
content array The content of this news item.
newsFeeds array The newsFeeds where this item can be found. [`expandable`](#tag/news_feed_model)
validFrom string The moment from which this news item is valid, RFC3339 (date-time)
validUntil string The moment until which this news item is valid, RFC3339 (date-time)
lastModified string The moment on which this news item was updated, RFC3339 (date-time)
consumers array The additional consumer elements that can be provided, see the [documentation on support for specific consumers](https://openonderwijsapi.nl/v5/#/technical/consumers-and-profiles/) for more informatio
ext object
View JSON Schema on GitHub

JSON Schema

open-education-api-news-item-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/open-education-api/json-schema/open-education-api-news-item-schema.json",
  "title": "NewsItem",
  "description": "A newsitem contains the message and metadata of that message",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/open-education-api-news-api-openapi.yml#/components/schemas/NewsItem",
  "type": "object",
  "required": [
    "newsItemId",
    "name"
  ],
  "properties": {
    "newsItemId": {
      "type": "string",
      "description": "Unique id for this news item",
      "format": "uuid"
    },
    "newsItemType": {
      "$ref": "#/$defs/newsItemType"
    },
    "name": {
      "type": "array",
      "description": "The name for this news item",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/LanguageTypedString"
      }
    },
    "authors": {
      "type": "array",
      "description": "The authors of the article with this news item",
      "items": {
        "type": "string",
        "maxLength": 256
      }
    },
    "image": {
      "type": "string",
      "description": "The url containing the address of the image belonging to this news item",
      "format": "uri",
      "maxLength": 2048
    },
    "link": {
      "type": "string",
      "description": "The url containing the address of the article belonging to this news item",
      "format": "uri",
      "maxLength": 2048
    },
    "content": {
      "type": "array",
      "description": "The content of this news item.",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/LanguageTypedString"
      }
    },
    "newsFeeds": {
      "description": "The newsFeeds where this item can be found. [`expandable`](#tag/news_feed_model)",
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/$defs/Identifier",
            "title": "newsFeedId"
          },
          {
            "$ref": "#/$defs/NewsFeed",
            "title": "NewsFeed"
          }
        ]
      }
    },
    "validFrom": {
      "type": "string",
      "description": "The moment from which this news item is valid, RFC3339 (date-time)",
      "format": "date-time"
    },
    "validUntil": {
      "type": "string",
      "description": "The moment until which this news item is valid, RFC3339 (date-time)",
      "format": "date-time"
    },
    "lastModified": {
      "type": "string",
      "description": "The moment on which this news item was updated, RFC3339 (date-time)",
      "format": "date-time"
    },
    "consumers": {
      "description": "The additional consumer elements that can be provided, see the [documentation on support for specific consumers](https://openonderwijsapi.nl/v5/#/technical/consumers-and-profiles/) for more information about this mechanism.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Consumer"
      }
    },
    "ext": {
      "$ref": "#/$defs/Ext"
    }
  },
  "$defs": {
    "Consumer": {
      "type": "object",
      "description": "Object for communicating data to a specific consumer (destination). This object has no relationship with the `consumer` query parameter.",
      "required": [
        "consumerKey"
      ],
      "properties": {
        "consumerKey": {
          "description": "The key of the consumer (destination) for which this information is intended. See the [consumer registry](https://openonderwijsapi.nl/v5/#/technical/consumers-and-profiles/) for more information.",
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "Ext": {
      "type": "object",
      "description": "Object for additional non-standard attributes"
    },
    "Identifier": {
      "type": "string",
      "description": "An identifier of another resource.",
      "format": "uuid"
    },
    "LanguageTypedString": {
      "type": "object",
      "description": "A String with an associated language code.",
      "properties": {
        "language": {
          "description": "The language used in the described entity. A string formatted according to RFC3066.",
          "type": "string",
          "pattern": "^[a-z]{2,4}(-[A-Z][a-z]{3})?(-([A-Z]{2}|[0-9]{3}))?$"
        },
        "value": {
          "description": "String to describe the entity.",
          "type": "string"
        }
      }
    },
    "NewsFeed": {
      "type": "object",
      "description": "A placeholder or collection of news items",
      "required": [
        "newsFeedId",
        "newsFeedType",
        "name",
        "description"
      ],
      "properties": {
        "newsFeedId": {
          "type": "string",
          "description": "Unique id for this news feed",
          "format": "uuid"
        },
        "newsFeedType": {
          "type": "string",
          "description": "The type of the object this news feed relates to",
          "enum": [
            "organization",
            "program",
            "course",
            "component",
            "person",
            "building",
            "room"
          ]
        },
        "name": {
          "type": "array",
          "description": "The name for this news feed",
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/LanguageTypedString"
          }
        },
        "description": {
          "type": "array",
          "description": "The description of this news feed.",
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/LanguageTypedString"
          }
        },
        "consumers": {
          "description": "The additional consumer elements that can be provided, see the [documentation on support for specific consumers](https://openonderwijsapi.nl/v5/#/technical/consumers-and-profiles/) for more information about this mechanism.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/Consumer"
          }
        },
        "ext": {
          "$ref": "#/$defs/Ext"
        }
      }
    },
    "newsItemType": {
      "type": "string",
      "description": "The type of this news item\n- calamity: calamiteit\n- general: algemeen\n- schedule-change: roosterwijziging\n- announcement: aankondiging\n",
      "enum": [
        "calamity",
        "general",
        "schedule-change",
        "announcement"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/open-education-api-news-item"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.