@cef-ebsi/vcdm1.1-dc4eu-higher-education-transcript-of-records

European Higher Education Transcript of Records

Profile schema extending the base EDC-W3C-VC to define academic transcript credentials in higher education.

The schema is published to the Trusted Schemas Registry with the IDs:

• 0x17002183f88917b747f4fec7009dc2f07b6fce2e8d8b1f225441307c653aa1b2 (hexadecimal)
• z2YnVatyvh9UvjnBKHWtJNH3iZrD9dWR8r7pGBTFjJiVF (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "European Higher Education Transcript of Records",
  "description": "Profile schema extending the base EDC-W3C-VC to define academic transcript credentials in higher education.",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-europass-edc-schema/schema.json"
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "const": [
            "VerifiableCredential",
            "VerifiableAttestation",
            "EuropeanDigitalCredential",
            "EuropeanHigherEducationTranscriptOfRecords"
          ]
        },
        "credentialSubject": {
          "type": "object",
          "required": [
            "id",
            "type",
            "dateOfBirth",
            "familyName",
            "givenName",
            "hasClaim"
          ],
          "properties": {
            "hasClaim": {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "object",
                "required": ["type", "title", "awardedBy", "wasDerivedFrom"],
                "properties": {
                  "type": {
                    "type": "string",
                    "const": "LearningAchievement"
                  },
                  "title": {
                    "type": "object"
                  },
                  "awardedBy": {
                    "type": "object",
                    "required": ["awardingBody", "location"],
                    "properties": {
                      "awardingBody": {
                        "type": "object"
                      },
                      "location": {
                        "type": "object"
                      }
                    }
                  },
                  "wasDerivedFrom": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": ["title", "creditPoint", "grade", "temporal"],
                      "properties": {
                        "title": {
                          "type": "object"
                        },
                        "creditPoint": {
                          "type": "array",
                          "minItems": 1
                        },
                        "grade": {
                          "type": "object"
                        },
                        "temporal": {
                          "type": "object",
                          "required": ["startDate", "endDate"],
                          "properties": {
                            "startDate": {
                              "type": "string",
                              "format": "date"
                            },
                            "endDate": {
                              "type": "string",
                              "format": "date"
                            }
                          }
                        }
                      }
                    }
                  },
                  "grantedBy": {
                    "type": "object"
                  }
                }
              }
            }
          }
        },
        "displayParameter": {
          "type": "object"
        },
        "credentialProfiles": {
          "type": "array",
          "items": {
            "type": "object"
          }
        }
      }
    }
  ]
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-dc4eu-higher-education-transcript-of-records@1.0.0-next.1

# with Yarn
yarn add @cef-ebsi/vcdm1.1-dc4eu-higher-education-transcript-of-records@1.0.0-next.1

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-dc4eu-higher-education-transcript-of-records@1.0.0-next.1

Usage

The package exports the schema and its metadata as JavaScript objects:

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-dc4eu-higher-education-transcript-of-records";

// you can now use the schema and metadata

In addition, the package exports a TypeScript type corresponding to the schema:

import type { EuropeanHigherEducationTranscriptOfRecords } from "@cef-ebsi/vcdm1.1-dc4eu-higher-education-transcript-of-records";

License

Copyright (C) 2024 European Union

This program is free software: you can redistribute it and/or modify it under the terms of the EUROPEAN UNION PUBLIC LICENCE v. 1.2 as published by the European Union.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EUROPEAN UNION PUBLIC LICENCE v. 1.2 for further details.

You should have received a copy of the EUROPEAN UNION PUBLIC LICENCE v. 1.2. along with this program. If not, see https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12.