Skip to content

Metadata Extensions for Edubadges

Jump to bottom
Frans Ward edited this page Dec 10, 2023 · 6 revisions

EduBadges Metadata Extensions (Open Badges V2)

EduBadges is using an extended set of the Open Badges Specification V2 to comply with the European Educational standards as agreed upon in the Bologna Process.

These metadata extensions have been implemented in Edubadges:

Metadata extensions for the Issuer

Metadata extensions for the Badgeclass

Institution Name Extension

extensions:InstitutionNameExtension

Name of institution

Example: Delft University of Technology

json:

{ 
   "extensions:InstitutionNameExtension": 
  { 
      "@context":"https://w3id.org/openbadges/extensions/InstitutionNameExtension/context.json", 
      "type": ["Extension", "extensions:InstitutionNameExtension"], 
      "InstitutionName": "Delft University of Technology" 
   } 
}

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "InstitutionName": "extensions:InstitutionNameExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:InstitutionNameExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/InstitutionNameExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Institution Name Extension",
   "description": "An extension that allows you to add a single string InstitutionName to an issuer object.",
   "type": "object",
   "properties": {
     "InstitutionName": {
       "type": "string"
     }
   },
   "required": ["InstitutionName"]
 }

Institution Identifier Extension

extensions:InstitutionIdentifierExtension

An identifier that identifies the institution.

Example: Institution Identifier for the Hogeschool Rotterdam: 22OJ

json:

 { 
    "extensions:InstitutionIdentifierExtension": {
       "@context":"https://w3id.org/openbadges/extensions/InstitutionIdentifierExtension/context.json",
       "type": ["Extension", "extensions:InstitutionIdentifierExtension"], 
       "InstitutionIdentifier": "22OJ" 
    } 
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "InstitutionIdentifier": "extensions:InstitutionIdentifierExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:InstitutionIdentifierExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/extensions:InstitutionIdentifierExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Institution Identifier Extension",
   "description": "An extension that allows you to add a single string InstitutionIdentifier to an issuer object.",
   "type": "object",
   "properties": {
     "InstitutionIdentifier": {
       "type": "string"
     }
   },
   "required": ["InstitutionIdentifier"]
 }

Grading Table Extension

extensions:GradingTableExtension

Reference (URL) to the institution's grading table.

Example: https://www.eur.nl/onderwijs/praktische-zaken/afstuderen/ects-grading-table

json:

 { 
    "extensions:GradingTableExtension": {
       "@context":"https://w3id.org/openbadges/extensions/GradingTableExtension/context.json",
       "type": ["Extension", "extensions:GradingTableExtension"], 
       "GradingTableURL": "https://www.eur.nl/onderwijs/praktische-zaken/afstuderen/ects-grading-table" 
    } 
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "GradingTableURL": "extensions:GradingTableExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:GradingTableExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/extensions:GradingTableExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Grading Table Extension",
   "description": "An extension that allows you to add a single url to a webpage providing the institution Grading Table.",
   "type": "object",
   "properties": {
     "GradingTableURL": {
       "type": "string"
       "format: "uri"
     }
   },
   "required": ["GradingTableURL"]
 }

Language Extension

extensions:LanguageExtension

Language of instruction.

Notation: ISO-3166-1 notatie, Java Locale Code: nl_NL https://www.freeformatter.com/netherlands-standards-code-snippets.html

Example: Language: "nl_NL"

json:

 {
    "extensions:LanguageExtension": {
       "@context":"https://w3id.org/openbadges/extensions/LanguageExtension/context.json",
       "type": ["Extension", "extensions:LanguageExtension"],
       "Language": "nl_NL"
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "Language": "extensions:LanguageExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:LanguageExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/LanguageExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Language Extension",
   "description": "An extension that allows you to add a single string Language to a badgeclass object that represents the language of instruction.",
   "type": "object",
   "properties": {
     "Language": {
       "type": "string"
     }
   },
   "required": ["Language"]
 }

ECTS Extension

extensions:ECTSExtension

ECTS: Number of European Credit Transfer and Accumulation System. In increments of 0,5 ECTS. Minimal 0,5 and maximal 240 ECTS.

Example: ECTS: 2,5

json:

 {
    "extensions:ECTSExtension": {
       "@context":"https://w3id.org/openbadges/extensions/ECTSExtension/context.json",
       "type": ["Extension", "extensions:ECTSExtension"],
       "ECTS": 2,5
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "ECTS": "extensions:ECTSExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:ECTSExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/ECTSExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "ECTS Extension",
   "description": "An extension that allows you to add an ECTS - European Credit Transfer and Accumulation System - number to a badgeclass object.",
   "type": "object",
   "properties": {
     "ECTS": {
       "type": "number"
     }
   },
   "required": ["ECTS"]
 }

Study Load Extension

extensions:StudyLoadExtension

Study load in hours.

Not all institutions use ECTS as information to express the credits that the badgeclass represent. Some express the study load in hours, like the intermediate vocational education (MBO) institutions in the Netherlands. This fact is also known as Studiebelastingsuren or SBU in the Netherlands.

Example: StudyLoadHours: 24

json:

 {
    "extensions:StudyLoadExtension": {
       "@context":"https://w3id.org/openbadges/extensions/StudyLoadExtension/context.json",
       "type": ["Extension", "extensions:StudyLoadExtension"],
       "StudyLoadHours": 24
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "StudyLoadHours": "extensions:StudyLoadExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:StudyLoadExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/StudyLoadExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Study Load in Hours Extension",
   "description": "An extension that allows you to add the study load in hours to a badgeclass object.",
   "type": "object",
   "properties": {
     "StudyLoadHours": {
       "type": "number"
     }
   },
   "required": ["StudyLoadHours"]
 }

Time Investment Extension

extensions:TimeInvestmentExtension

Time investment in hours.

Where the ECTSExtension and StudyLoadExtension are used for badges that can be earned as part of a formal curriculum. (the formal badges in edubadges), this TimeInvestmentExtension metadata extension can be added to a non-formal badgeclass to indicate the investment in hours that the earner need to invest to be able to earn this badge.

Example: TimeInvestment: 36

json:

 {
    "extensions:TimeInvestmentExtension": {
       "@context":"https://w3id.org/openbadges/extensions/TimeInvestmentExtension/context.json",
       "type": ["Extension", "extensions:TimeInvestmentExtension"],
       "TimeInvestment": 36
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "TimeInvestment": "extensions:TimeInvestmentExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:TimeInvestmentExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/TimeInvestmentExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Time Investment Extension",
   "description": "An extension that allows you to add the time investment, expressed in hours needed to earn that badgeclass object.",
   "type": "object",
   "properties": {
     "TimeInvestment": {
       "type": "number"
     }
   },
   "required": ["TimeInvestment"]
 }

EQF Extension

extensions:EQFExtension

Information the level of the course according to the International Standard Classification of Education (ISCED). In The Netherlands expressed as NLQF. Whole numbers between 1 and 8 only.

See: https://ec.europa.eu/eurostat/statistics-explained/index.php/International_Standard_Classification_of_Education_(ISCED)

Example: 7

json:

 {
    "extensions:EQFExtension": {
       "@context":"https://w3id.org/openbadges/extensions/EQFExtension/context.json",
       "type": ["Extension", "extensions:EQFExtension"],
       "EQF": 7
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "EQF": "extensions:EQFExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:EQFExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/EQFExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "EQF Extension",
   "description": "An extension that allows you to add a single number EQF to a badgeclass object.",
   "type": "object",
   "properties": {
     "EQF": {
       "type": "number"
     }
   },
   "required": ["EQF"]
 }

Learning Outcome Extension

extensions:LearningOutcomeExtension

Describes the learning outcome

Example: Will appreciate the benefits of learning a foreign language.

json:

 {
    "extensions:LearningOutcomeExtension": {
       "@context":"https://w3id.org/openbadges/extensions/LearningOutcomeExtension/context.json",
       "type": ["Extension", "extensions:LearningOutcomeExtension"],
       "LearningOutcome": "Will appreciate the benefits of learning a foreign language."
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "LearningOutcome": "extensions:LearningOutcomeExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:LearningOutcomeExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/LearningOutcomeExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "LearningOutcome Extension",
   "description": "An extension that allows you to add a single string LearningOutcome to a badgeclass object.",
   "type": "object",
   "properties": {
     "LearningOutcome": {
       "type": "string"
     }
   },
   "required": ["LearningOutcome"]
 }

Education Program Identifier Extension

extensions:EducationProgramIdentifierExtension

An identifier that identifies the education program. In the Netherlands this is the ISAT code of an education program. Het Centraal Register Opleidingen Hoger Onderwijs (CROHO) bevat gegevens van vroegere, actuele en toekomstige opleidingen.

Zie: https://apps.duo.nl/MCROHO/pages/zoeken.jsf

Example: Erasmus Universiteit Rotterdam Opleiding: Algemene Cultuurwetenschappen ISAT code: 56823

json:

 {
    "extensions:EducationProgramIdentifierExtension": {
       "@context":"https://w3id.org/openbadges/extensions/EducationProgramIdentifierExtension/context.json",
       "type": ["Extension", "extensions:EducationProgramIdentifierExtension"],
       "EducationProgramIdentifier": 56823
    }
 }

context.json:

 {
   "@context": {
     "obi": "https://w3id.org/openbadges#",
     "extensions": "https://w3id.org/openbadges/extensions#",
     "EducationProgramIdentifier": "extensions:EducationProgramIdentifierExtension"
   },
   "obi:validation": [
     {
       "obi:validatesType": "extensions:EducationProgramIdentifierExtension",
       "obi:validationSchema": "https://w3id.org/openbadges/extensions/EducationProgramIdentifierExtension/schema.json"
     }
   ]
 }

schema.json:

 {
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Education Program Identifier Extension",
   "description": "An extension that allows you to add a single string EducationProgramIdentifier to a badgeclass object.",
   "type": "object",
   "properties": {
     "EducationProgramIdentifier": {
       "type": "number"
     }
   },
   "required": ["EducationProgramIdentifier"]
 }
Clone this wiki locally