Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Alignments to Open Badges 3.0 Display #681

Open
kayaelle opened this issue Jan 27, 2025 · 0 comments
Open

Add Alignments to Open Badges 3.0 Display #681

kayaelle opened this issue Jan 27, 2025 · 0 comments

Comments

@kayaelle
Copy link
Contributor

kayaelle commented Jan 27, 2025

Is your feature request related to a problem? Please describe.
Open Badges 3.0 may contain "alignments" to educational frameworks: https://www.imsglobal.org/spec/ob/v3p0#alignment

and we want to display them in the credential.

Describe the solution you'd like
The alignment object could be found in the achievement object. If found, we should display the header "Alignments" and below, list each alignment as:

<a href=""targetUrl">targetName</a>
targetDescription

Notes:

  • targetDescription is optional
  • even though it is required, targetURL may not be present, in those cases, just display the name in regular body text.
  • Other elements like: targetCode, targetFramework, and targetType can be ignored

Example of an Open Badge with Alignments:

Image

Example of Open Badge code with alignments

{
  "@context": [
    "https://www.w3.org/ns/credentials/v2",
    "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json"
  ],
  "id": "http://example.edu/credentials/3732",
  "type": ["VerifiableCredential", "OpenBadgeCredential"],
  "issuer": {
    "id": "https://example.edu/issuers/565049",
    "type": ["Profile"],
    "name": "Example University"
  },
  "validFrom": "2010-01-01T00:00:00Z",
  "name": "Example University Degree",
  "credentialSubject": {
    "id": "did:example:ebfeb1f712ebc6f1c276e12ec21",
    "type": ["AchievementSubject"],
    "achievement": {
      "id": "https://1edtech.edu/achievements/1",
      "type": ["Achievement"],
      "criteria": {
        "narrative": "Cite strong and thorough textual evidence to support analysis of what the text says explicitly as well as inferences drawn from the text, including determining where the text leaves matters uncertain"
      },
      "description": "Analyze a sample text",
      "name": "Text analysis",
      "alignment": [{
        "type": ["Alignment"],
        "targetCode": "ce-cf4dee18-7cea-443a-b920-158a0762c6bf",
        "targetFramework": "Edmonds College Course Catalog",
        "targetName": "Requirements Analysis",
        "targetUrl": "https://credentialfinder.org/credential/20229/Requirements_Analysis"
      },
      {
        "type": ["Alignment"],
        "targetName": "Requirements Analysis",
        "targetUrl": "https://credentialfinder.org/credential/20229/Requirements_Analysis",
        "targetDescription": "This is a description"
      }]
    }
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog
Development

No branches or pull requests

1 participant