RSS Feed Specifications
Video-Metaportal unterrichtsvideos.net | Version 1.1 (08.03.2021) | [PDF] [Changelog]

This manual contains specifications of an RSS feed used to exchange metadata between channel providers (e.g. ProVision) and Metaportal.

1. Channel Specifications

General information about video provider / channel.

Color	Tag	Specification	Description	Example
— tags by RSS 2.x specification —
	title	TEXT	Channel title	ProVision
	link	LINK	Channel’s absolute URI	https://www.wwu.de/provision/
	description	TEXT	Channel description	Videoportal ProVision der WWU Münster \| learning professional vision
	language	RSS	Channel’s main language	de-de
	copyright	TEXT	Copyright info	Copyright 2018 ProVision
	pubDate	DATE RSS	Date: first published	Wed, 26 Sep 2018 10:34:44 +0200
	lastBuildDate	DATE RSS	Date: last modified feed	Wed, 26 Sep 2018 10:36:44 +0200
	image	RSS	Channel logo with required RSS 2.x elements: `URL`, `Title`, `Link` URI to JPEG, PNG, GIF	<image> <title>ProVision</title> <url>https://.../logo.png</url> <link>https://.../</link> </image>
— custom tags —
	channel_version	1.1	Specification version of channel	1.1

2. Item Specifications – Meta Data

Each video or clip is represented by a unique <item>.

Color	Tag	Specification	Description	Example
— tags by RSS 2.x specification —
	title	CDATA	Main title of video	<![CDATA[Satz des Pythagoras – 3. Doppelstunde]]>
	link	TEXT (LINK)	Direct URI to video/item page	https://www.wwu.de/video.html
	description	CDATA	Long description of content	<![CDATA[In dieser Doppelstunde wird…]]>
	language	RSS	Main language of item	de-de
	copyright	TEXT	Individual video copyright	Studiumdigitale, GU Frankfurt
	pubDate	DATE	Date first published	Wed, 26 Sep 2018 10:34:44 +0200
	lastBuildDate	DATE	Date last modified	Wed, 26 Sep 2018 10:36:44 +0200
— custom tags —
	id	TEXT (max. 150 chars)	Permanent item identifier must not be re-assigned must be unique in channel feed must not contain whitespaces must not contain: : / ? # [ ] @ ! $ & ' ( ) * + , ; = Can contain: A–Z, a–z, 0–9 and special chars: - . _	53
	parent_id	TEXT (list) separated by vertical bar: value \| value	List of video ids (IDs: parent) **	45 \| 12
	child_id	TEXT (list) separated by vertical bar: value \| value	List of video ids (IDs: child) **	2 \| 3
	subtitle	CDATA	Subtitle of video item	<![CDATA[Zieht ein Magnet überall gleich stark an?]]>
	teaser	CDATA	Short teaser description of clip/video	<![CDATA[Dieser Clip enthält XY…]]>
	video_image	TEXT (https-URI)	Video preview image, URI to JPEG, PNG, GIF	https://…/teaserbild.jpeg
	video_duration	(HH:MM:SS)	Total video length	01:12:23
	video_resolution	(W)x(H)	Maximum video resolution in Pixel	1280x720
	use_restrictions	TEXT (list) separated by vertical bar: value \| value	Restrictions of use (see table) ***	G1:1 \| G2:2 \| G6:3
	use_restrictions_label	CDATA	Descriptive restrictions of use (human readable)	<![CDATA[abrufbar nur für Studierende…]]>
	focus_of_analysis	TEXT (list) separated by vertical bar: value \| value	Suggested focus areas	Sprachsensible Lernunterstützung \| Klassenführung
	materials	TEXT (list)separated by vertical bar: value \| value	Materials available	Lehrmaterialien \| Schülermaterialien \| Transkript \| Unterrichtsverlaufsplan
	camera_perspective	TEXT (list) separated by vertical bar: value \| value	Camera perspective of video / POV	Lehrerkamera \| Totale
	lecture_activities	TEXT (list) separated by vertical bar: value \| value	Student activities	Gruppenarbeit \| Schülerpräsentation
	lecture_phase	TEXT (list) separated by vertical bar: value \| value	Lecture phases	Einstiegsphase \| Erarbeitungsphase \| Reflexionsphase
	lecture_type	Animationsvideo Unterrichtsreihe Unterrichtsstunde Unterrichtsausschnitt Interview Inszenierte Videoaufnahme Sonstige Videos	Lecture type Multiple grades separated by vertical bar: value \| value (order does not matter)	Unterrichtsstunde
	school_type	Vorschule Grundschule Hauptschule Realschule Gesamtschule Gymnasium Förderschule Privat- und Ersatzschulen Sekundarschule Berufliche Bildung Sonstige Schulformen	Type of School Multiple grades separated by vertical bar: value \| value (order does not matter)	Grundschule
	grade	Vorschule 1 2 3 4 5 6 7 8 9 10 11 12 13 Nicht zutreffend	Grade level Multiple grades separated by vertical bar: value \| value (order does not matter)	5
	subject	(Alt-)Griechisch Bildende Kunst/Kunst/Kunsterziehung Biologie Chemie Deutsch Englisch Erdkunde/Geographie Ethik/Religionskunde Ev. Religion Französisch Geschichte Informatik Italienisch Kath. Religion Latein Mathematik Musik Philosophie Physik Russisch Sachunterricht Sozialkunde/Politik Spanisch Sport Wirtschaft/Verwaltung/Recht Berufliche Fachrichtungen Sonstiges Fachübergreifender Unterricht	Subject * -- Naturwissenschaften = „Fachübergreifender Unterricht“ Körperpflege = „Berufliche Fachrichtungen“ Energie und Umwelt (Maschinenbau) = „Berufliche Fachrichtungen“ Freiarbeit = „Sonstiges“ -- Fachübergreifender Unterricht: If multiple subjects feed should at least contain: „Fachübergreifender Unterricht“ Multiple subjects separated by vertical bar: value \| value (order does not matter)	Deutsch \| Chemie \| Fachübergreifender Unterricht or Fachübergreifender Unterricht or Mathematik
	references	CDATA (+ BibTeX)	BibTeX markup	<![CDATA[@book{book, author = {The author}, title = {The title}, publisher = {The publisher}, year = (The year), address = {The address}, isbn = {1234567890123} }]]>

3. Legend & Rules for Feed and Content

Orange = Required by RSS 2.x

Green = Required by Metaportal, Open naming

Blue = Required by Metaportal, Closed naming

Grey = Optional

Rules for Feed and Content:

Absolute URIs only; HTTPS for images/content.
Dates per RSS 2.0 spec.
Each tag appears once; order not mandatory.
Multi-value fields separated with “ | ”.
Required tags must be present; optional may be omitted.

Note: There can be more tags in the rss feed than specified above which will be ignored while parsing by metaportal. The order of tags as listed above is not mandatory and can be modified. Make sure all required fields are included in the feed, only tags declared as optional can be omitted.

* Subject

If there is more than one subject, list all of them and also make sure to include “Fachübergreifender Unterricht” too. Make sure each subject term matches a closed naming tag, so e.g. instead of “Freiarbeit” the RSS feed should contain “Sonstiges” (compare with list above at field specification).

** Parent / Child Logic

To publish linked videos and to show a simple parent/child logic, the channel provider can maintain a list of IDs pointing to parent video or childs. If ID is a parent, there should be a list of childs (child_id). Every ID which is a child should have a parent_id link. If ID is not a parent, child_id can be omitted.

*** Table / Scheme of use_restrictions field – Example and explanation:

The use_restrictions field defines access possibilities for a concrete video item and specific pre-defined user groups as listed below (G0 – G7). For each of those groups an access level can be specified after a colon. User groups with no access (access level = 0) can be omitted in field value. Example: use_restrictions = G1:1 | G2:2 | G6:3

Table / Scheme of `use_restrictions` field – Example and explanation
Value	Access Level	User Group #
		G0	G1	G2	G3	G4	G5	G6	G7
		Sonstige	Lehramtsstudierende	Lehrkräfte im Vorbereitungsdienst	Hochschullehrende der 1. Phase des Lehramts	Lehrende in der 2. Phase	Lehrende in der 3. Phase	Lehrkräfte	Unterrichtsforscher
0	No access	0	1	2	0	0	0	3	0
1	Local access
2	Trust network access
3	Global access
Results in mapping of		State	University	State	University	State	State	State	University

**Definition of “access level”**
Value	Access Level	Description	Effect on Metaportal filter
0	No access	(self-explanatory)	Video won’t be displayed when this user group is selected
1	Local access	Based on the RSS provider’s location and specified user group, either university or state related to the channel/provider will automatically be mapped. Example: ProVision is provided by WWU Münster: Depending on a specific user group which has level 1 (local access) to the video, the related state = NRW or university = WWU Münster will be mapped as access possibility to that specific video item.	Video will be displayed when selected location is identical to location of university (provider) or its related state (depending on user group). Only location of specific RSS provider / video portal / channel will be mapped.
2	Trust network access	All universities and states contributing to Metaportal which are Trust Network partners (cooperation contract)	Video will be displayed if any cooperation university or its related state (depending on user group) is selected in filter
3	Global access	Wide user range access possibility (e.g. all verified legitimated SSO users). This level results in mapping each university or state in Metaportal filter.	Video will be displayed on Metaportal whatever the user selects as user group and location in filter on search page.

Example

Example from the table above for the value of the use_restrictions field if provider is ProVision:

Field: use_restrictions = G1:1 | G2:2 | G6:3
Note: User groups with no access (access level = 0) can be omitted.

Meaning of the use_restrictions value in context of ProVision being the provider of the RSS feed:

G1:1 maps local access possibility of group “Lehramtsstudierende” – only students of “WWU Münster” (the channel provider) can view the video.
G2:2 maps trust network access possibility of group “Lehrkräfte im Vorbereitungsdienst” – all group members based in any state related to universities contributing to the trust network (per the cooperation contract) can view the video.
G6:3 maps global access possibility of group “Lehrkräfte” – all group members in all states and universities can view the video.

Remember

You can specify an access level for each individual video item, but keep in mind that this is only a descriptive mapping of use restrictions. It has no direct effect on actual access control; it only affects the filter options in Metaportal. If you’re unsure, follow this premise: better to have the video displayed rather than filtered out. You can also use the use_restrictions_label field to inform users how they might access the video.

RSS Feed Specifications Video-Metaportal unterrichtsvideos.net | Version 1.1 (08.03.2021) | [PDF] [Changelog]