@cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema v1.0.1

@cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema

NOVA IMS Digital Credential

Schema defining a verifiable credential issued by NOVA IMS representing a student's course enrolment details.

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

• 0xf1f46bda26e2fbaa635bd6061c0851409ca3bc3e3cb4f521a61da0af5704f92b (hexadecimal)
• zHHVRWcMrTiJB1t3r9SoPrPh4YMKSVH4yDyD9x6UQNLPk (multibase base58btc)

Table of Contents

• JSON Schema
• Installation
• Usage
• License

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NOVA IMS Digital Credential",
  "description": "Schema defining a verifiable credential issued by NOVA IMS representing a student's course enrolment details.",
  "type": "object",
  "allOf": [
    {
      "$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
    },
    {
      "properties": {
        "credentialSubject": {
          "description": "Contains details about the student and their course enrolment at NOVA IMS.",
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string",
              "description": "The given name(s) of the student."
            },
            "familyName": {
              "type": "string",
              "description": "The family name(s) of the student."
            },
            "courseName": {
              "type": "string",
              "description": "The official name of the course of study at NOVA IMS."
            },
            "specialization": {
              "type": "string",
              "description": "The specialisation within the course, if applicable."
            },
            "startDate": {
              "type": "string",
              "format": "date",
              "description": "The official start date of the student's enrolment in the course (YYYY-MM-DD)."
            },
            "endDate": {
              "type": "string",
              "format": "date",
              "description": "The official or expected end date of the student's enrolment (YYYY-MM-DD)."
            }
          },
          "required": [
            "firstName",
            "familyName",
            "courseName",
            "startDate",
            "endDate"
          ]
        }
      }
    }
  ],
  "$defs": {}
}

Installation

# with npm
npm add @cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema@1.0.1

# with Yarn
yarn add @cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema@1.0.1

# with pnpm
pnpm add @cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema@1.0.1

Usage

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

import {
  schema,
  metadata,
} from "@cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema";

// you can now use the schema and metadata

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

import type { NOVAIMSDigitalCredential } from "@cef-ebsi/vcdm1.1-nova-ims-digital-credential-schema";

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.