OB3 Credential Examples

Examples of Open Badges V3 credentials based on the Educredentials metadata model. These examples can be used to test the capabilities of various wallets.

• 
  Extracurriculair Stage bij het luchtverkopersgilde MBO Beek De student leert de kunst van het verkopen van niet-bestaande producten en diensten.
• 
  Microcredential Oogcontact maken zonder creepy te kijken MBO Beek De student kan oogcontact maken tijdens verkoopgesprekken zonder ongemakkelijke situaties te creëren.
• 
  Diploma master in subtiele verkoopkunst MBO Beek De student heeft de ultieme beheersing van subtiele verkooptechnieken en kan mensen producten laten kopen die ze niet dachten nodig te hebben.
• 
  Extracurriculair Stage in de lokale snackbar MBO Beek De student doet praktijkervaring op in het bereiden van snacks in een snackbaromgeving.
• 
  Microcredential Frietje perfectie schillen MBO Beek De student beheerst de perfecte techniek voor het schillen van friet, inclusief het verminderen van aardappelsap en het behalen van de ideale frietdikte.
• 
  Diploma grootmeester in de frituurkunst MBO Beek De student is erkend als grootmeester in de kunst van het frituren, met een ongeëvenaard gevoel voor sauskeuze.
• 
  Nachtwacht bij slaperige ouderen MBO Beek De student heeft acht nachten non-stop wakker gebleven om te observeren hoe ouderen proberen in slaap te vallen.
• 
  Dekbed schudden voor gevorderden MBO Beek De student heeft de technieken voor het vouwen en opschudden van dekbedden tot perfectie onder de knie en kan deze toepassen in een realistische setting.
• 
  Diploma slapeloosheidsgoeroe MBO Beek De student beheerst technieken om mensen snel in slaap te krijgen, en is dé expert op het gebied van slaapverwekkende verhalen.
• 
  Stage bij boerderijdieren in therapie MBO Beek De student biedt emotionele ondersteuning aan boerderijdieren onder toezicht van een therapeut boer.
• 
  Basis miauw en blaf interpretatie MBO Beek De student begrijpt de basis van de communicatie van katten en honden, en kan hun primaire behoeftes herkennen.
• 
  Diploma dierenfluisteraar met erecode MBO Beek De student kan dieren verstaan en communiceren met dieren. De student heeft de erecode ondertekend en is een dierenfluisteraar.
• 
  Lightsaber Dueling Techniques Naboo Theed University To earn this badge, you must demonstrate proficiency in lightsaber dueling techniques.
• 
  Lightsaber Dueling Techniques Naboo Theed University To earn this badge, you must demonstrate proficiency in lightsaber dueling techniques.
• 
  Droid Factory Internship Naboo Theed University Participate in a 2-week internship at the Naboo Droid Factory.
• 
  Lightsaber Dueling Techniques Naboo Theed University To earn this badge, you must demonstrate proficiency in lightsaber dueling techniques.
• 
  Minor: Jedi Mind Control and Advanced Meditation Practices Naboo Theed University To earn this badge, you must attend the colleges on Mind Control, and on Meditation. You must pass a practical test and submit a written essay.
• 
  Minor: Jedi Mind Control and Advanced Meditation Practices Naboo Theed University To earn this badge, you must attend the colleges on Mind Control, and on Meditation. You must pass a practical test and submit a written essay.
• 
  Droid Maintenance and Repair Naboo Theed University To earn this credential, students must: * complete all course modules * pass the final exam * complete a final project * achieve a final project grade of 6 or higher The final project grade is calculated as the average of the grades for the final exam and the final project.
• 
  Minor: Jedi Mind Control and Advanced Meditation Practices Naboo Theed University To earn this badge, you must attend the colleges on Mind Control, and on Meditation. You must pass a practical test and submit a written essay.
• 
  The Force and Its Applications Naboo Theed University This badge is awarded for completing the course 'The Force and Its Applications'
• 
  The Force and Its Applications Naboo Theed University This badge is awarded for completing the course 'The Force and Its Applications'
• 
  Pod Tuning and Boosting Naboo Theed University Thi
• 
  The Force and Its Applications Naboo Theed University This badge is awarded for completing the course 'The Force and Its Applications'
• 
  Microcredential Basisomzetting Kat naar Koffiezetapparaat Universiteit van Harderwijk De student heeft de eerste stap van transmutatie afgerond, waarbij katten zonder blijvende schade worden omgezet in keukenapparatuur.
• 
  Microcredential Terugverandering zonder Wroeging Universiteit van Harderwijk De student kan experimenten veilig terugdraaien zonder schuldgevoel of blijvende psychologische schade aan huisdier of eigenaar.
• 
  Diploma Grootmeester Huisdier-Transmutator Universiteit van Harderwijk De student beheerst alle geheimen van transmutatie en kan zonder problemen een konijn in een koffiemachine veranderen en weer terug.
• 
  Extracurriculair Stage bij Het Ministerie van Onnodige Zaken Universiteit van Harderwijk De student voltooide een stage bij een overheidsinstelling die zich richt op beleid dat nergens over gaat.
• 
  Microcredential Argumenteren over Onzinnige Zaken Universiteit van Harderwijk De student kan urenlang doorpraten over onderwerpen die niemand interesseren, zoals de perfecte afschuining van een pizzapunt.
• 
  Diploma Meester in het Zinloze Denken Universiteit van Harderwijk De student is een expert geworden in het bedenken van argumenten die geen praktisch nut hebben, zoals filosoferen over de levensduur van een stoplicht.

Table of Contents

SURF Documentation

• Formatting text badge class (examples of markdown support in Edubadges)
• Extra metadata: the spec supports extensions to the data model (https://www.imsglobal.org/spec/ob/v3p0#extending-the-data-model). In Edubadges, this is done with 17 extra metadata fields. (See Microcredentials Definition EU)
• See also the current Edubadges examples in OB2 format: Edubadges Metadata Examples - JSON output (internal wiki)
• Business Rules for attributes, possible values, and such from the OBV2 version are detailed in Badgeclass Business Rules
• Mapping from OB2 - OB3 is detailed in: Micro-credentials Metadata Mapping (internal wiki)

Questions

• Can we map from Educredentials to CASE-related alignment target types?
• Do we want to differentiate between “study load requested” vs “study load completed” - similar to creditsAvailable vs creditsEarned?
• What do we want to use as identifiers: did, did:web, URL?
• What do we want to do with multilingualism? One option can be found in the 1EdTech Localization Framework, but it is still in early preview. Alternatives include choosing a language when issuing a credential; the user may then have a credential per language. Another option is to use custom extensions for this, with the risk of deviating too far from the standard.
• What info/metadata should be included in the “quality framework” for MBO? For HO, we have the ECTSGradeScore. Is it different for MBO?
• Do we want to differentiate the top level, optional .name, with the nested, required .credentialSubject.achievement.name? If so, what would the difference be? Do we want the top level .name at all?

Assumptions and Choices

• For the language of the edubadge, we chose the “inLanguage” property because the description is “the language of the achievement”.
• For Grade Achieved, “Result” is used.
• For Learning Outcome, “ResultDescription” with type ext:ECTSScore is used with a Dutch scale of 1 to 10.
• For ECTS study load, creditsEarned (completed) and creditsAvailable are used.
• For IdentityChecked, a boolean was chosen because the current OBV2 model also has this; although this is not ideal - an enum would be better, so that NVT (Not Applicable) etc. can also be included.
• For Study Load, there is business logic. We don’t fully work this out in the schema to avoid complexity. However, the simple version is: Study load options: ECTS / SBU / Time investment
  • Three separate objects at the highest level in Achievement:
    • ECTS
    • SBU
    • TimeInvestment
  • Enforced per Achievement type:
    • microcredential: requires studyloadECTS
    • regular: requires studyloadECTS
• For BRIN and ShacHome, separate “otheridentifier” entries are included in the issuer.
• For issuer.id, we use the internal ID e.g. https://demo.educredentials.eu/public/institutions/9-TYGj4dTn-nW8CGfwGjAQ
• According to the Open Badges Implementation Guide, schemas for extensions are mandatory, whereas, according to the Open Badges Specification, they are optional. We have included them in the CredentialSchema list.

Educredentials: Current Model

We currently distinguish three types of credentials in Educredentials: Extracurricular, Regular, and Microcredential.
The difference between these three types is which metadata elements are used in the badge class.

	Microcredential	Regular Edubadge	Extracurricular Edubadge
Basic Information
Name	Required	Required	Required
Edubadge Image	Required	Required	Required
Description	Required	Required	Required
Learning Outcomes	Required	Required	Required
Criteria	Required	Required	Required
Program Information
Language of Instruction	Required	Required	Required
ECTS/SBU Credits	Optional	Required	Not Applicable
Time Investment	Optional	Not Applicable	Required
Indication of EQF Level	Required	Required	Optional
Participation Type	Required	Optional	Optional
Educational Codes	Optional	Required	Optional
Assessment Information
Assessment Type	Required	Optional	Optional
Supervision of Assessment	Required	Optional	Optional
Identity	Required	Optional	Optional
Quality Assurance
Name	Quality Framework HO/MBO	Optional	Optional
URL	Required	Optional	Optional
Description	Required	Optional	Optional
Related Educational Framework
Name	Optional	Optional	Optional
Framework	Optional	Optional	Optional
URL	Optional	Optional	Optional
Code	Optional	Optional	Optional
Description	Optional	Optional	Optional

Terms

With the introduction of OB3, several terms used in Educredentials (OB2) have changed:

OB2	OB3
Badgeclass	Digital Credential Achievement
Open Badge	Open Badge Credential
Edubadge	Digital Credential Assertion

(See also OB3 datamodel conceptual model)

ext: extensions:

“This enumeration can be extended with new, proprietary terms. The new terms must start with the substring ‘ext:’.”

EduCredential Examples

The following JSON code examples will be used to create the Open Badges V3 credentials. These will need to be signed by an agent to be used in wallets, but that is step 2.
The following types of OB3 examples are provided:

• Extracurricular - For knowledge and skills acquired outside the curriculum of a recognized program. No ECTS/SBU is associated with this badge class.
• Regular - For knowledge and skills acquired within the curriculum of a recognized program. ECTS/SBU is associated with this badge class.

• Microcredential - Microcredentials with the quality framework for HBO/WO or MBO professionals and all metadata in accordance with the EU recommendations.

• HO - Credentials for higher education, HBO, and WO.
• MBO - Credentials for secondary vocational education, MBO.

Three variants are worked out as examples for each type:

• Full - All mandatory and optional fields are filled in.
• Minimal - Only mandatory fields are filled in.
• Embedded - All mandatory fields are filled in. All optional fields with references to images are filled in. All images are included in the payload as base64 data URLs.

For MBO we only provide the full version, for no other reason than that managing six more variants is too much work.

We provide the different versions to check how the various wallets, verifiers and issuers handle the attributes:

• Embedded, to check how/if wallets, verifiers and issuers deal with embedded images and therefore large credentials.
• Minimal, so that wallets and verifiers have a reference of what attributes an Educredential will always carry.
• Full, so that wallets and verifiers have a reference of what attributes they might expect and should handle eventually.

Evidence

One example shows how an “evidence” can be included in the credential. The example with an evidence is mbob_zw_ssb_microcredential_full.json.

Both the VC data model spec and the OBv3 spec have an “evidence” entry in the spec. In both the VC data model and the OBv3 spec it lives at the JSON path .evidence[]. The structure and fields overlap, but OBv3 defines some optional extra fields. The VC data model spec has mechanisms, with fields, to ensure Integrity of Related Resources.

We define all fields from the OBv3 spec with one additional field digestMultibase from the VC data model spec. This is a multibase encoded digest of the evidence, which can be used to verify the integrity of the evidence.

NOTE: (@TODO) We don’t have automation in place to calculate the digestMultibase, so it is a dummy value in the examples.

Markdown

OBv3 allows Markdown in many data fields, without specifying which subset or variant.

Markdown A String that may contain Markdown.

https://www.imsglobal.org/spec/ob/v3p0/#org.1edtech.ob.v3p0.derived.markdown.class

We limit this in markdown.md. This subset is therefore not backward compatible with OBv3, which still allows code, links, tables, etc. We further restrict it for OBv3. Elements not detailed in markdown.md are therefore not allowed.

Validity

All _full versions have a validFrom and a validUntil, which are hardcoded to make them valid for 5 years starting from 30 August 2024.

URLs

Images hosted at https://raw.githubusercontent.com/ e.g. https://raw.githubusercontent.com/educredentials/obv3-examples/refs/heads/main/images/boerderijdieren.jpg

Contexts hosted at contexts.example.com, e.g. https://contexts.example.com/learning-outcome-extension.json

IDS

Ids are in the form of a URL. They use https and the following structure:

https://example.com/{resource}/{unique}

• Resource is the “thing” we are identifying in plural. E.g. a student would have the resource students and an Achievement the resource achievements
• Unique is some unique identifier, in reality problably some internal ID.

For the examples, we use the following mock unique identifiers:

- **Students:** - `stu-1A2B3C` - `stu-4D5E6F` - `stu-7G8H9I` - `stu-J1K2L3` - **Credentials:** - `crd-A1B2C3` - `crd-D4E5F6` - `crd-G7H8I9` - `crd-J0K1L2` - **Issuers:** - `iss-9Z8Y7X` - `iss-6W5V4U` - `iss-3T2S1R` - `iss-Q9P8O7` - **Achievements:** - `ach-33LML` - `ach-77NPN` - `ach-55BGB` - `ach-22RFR`

In the examples we will use the first always, except for the rare cases when we must convey that there are multiple resources in a single example.