Abstract

This document contains information about the JSON-LD terms used in 1EdTech Comprehensive Learner Record Standard.

Alternate versions of the vocabulary definition exist in Turtle.

Class definitions

This section contains information about all the JSON-LD classes used in 1EdTech Comprehensive Learner Record Standard

Achievement

Achievement

A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.

Properties

AchievementCredential

AchievementCredential

AchievementCredentials are representations of an awarded achievement, used to share information about a achievement belonging to one earner. Maps to a Verifiable Credential as defined in the [[VC-DATA-MODEL-2.0]]. As described in data-integrity, at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.

Subclass Of:
VerifiableCredential.

Properties

AchievementCredentialv1p1

AchievementCredentialv1p1

AchievementCredentials are representations of an awarded achievement, used to share information about a achievement belonging to one earner. Maps to a Verifiable Credential as defined in the [[VC-DATA-MODEL]]. As described in data-integrity, at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.

Subclass Of:
VerifiableCredentialv1p1.

Properties

AchievementSubject

AchievementSubject

A collection of information about the recipient of an achievement. Maps to Credential Subject in [[VC-DATA-MODEL-2.0]].

Subclass Of:
CredentialSubject.

Properties

AchievementSubjectv1p1

AchievementSubjectv1p1

A collection of information about the recipient of an achievement. Maps to Credential Subject in [[VC-DATA-MODEL-2.0]].

Subclass Of:
CredentialSubject.

Properties

Achievementv1p1

Achievementv1p1

A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.

Properties

Address

Address

An address for the described entity.

Properties

Alignment

Alignment

Describes an alignment between an achievement and a node in an educational framework.

Properties

AnyAchievementCredential

AnyAchievementCredential

AnyAchievementCredential represents an AchievementCredential that might be built using [[VC-DATA-MODEL]] or [[VC-DATA-MODEL-2.0]]. The scope of this class is only for verification purposes. It is not intended to be used in the creation of new credentials, where the achievementcredential class MUST be used.

Subclass Of:
AchievementCredential, AchievementCredentialv1p1.

AnyClrCredential

AnyClrCredential

AnyClrCredential represents an ClrCredential that might be built using [[VC-DATA-MODEL]] or [[VC-DATA-MODEL-2.0]]. The scope of this class is only for verification purposes. It is not intended to be used in the creation of new credentials, where the [[[#clrcredential]] class MUST be used.

Subclass Of:
ClrCredentialv1p1, ClrCredential.

AnyEndorsementCredential

AnyEndorsementCredential

AnyEndorsementCredential represents an EndorsementCredential that might be built using [[VC-DATA-MODEL]] or [[VC-DATA-MODEL-2.0]]. The scope of this class is only for verification purposes. It is not intended to be used in the creation of new credentials, where the [[[#endorsementcredential]] class MUST be used.

Subclass Of:
EndorsementCredential, EndorsementCredentialv1p1.

AnyIdentifier

AnyIdentifier

Can't find any description.

Properties

Association

Association

An Association describes the semantic relationship between two achievements and the credentials that assert those achievements.

Properties

ClrCredential

ClrCredential

A ClrCredential is a CLR with all the properties needed to conform with a Verifiable Credential as defined in the [[VC-DATA-MODEL-2.0]].

Subclass Of:
VerifiableCredential.

Properties

ClrCredentialJwtPayload

ClrCredentialJwtPayload

Represents a Comprehensive Learner Record (CLR) expressed to conform with the `vc` claim in JSON Web Token Proof Format [[VC-DATA-MODEL]]. Nested credentials are represented as Compact JWS strings.

Subclass Of:
ClrCredential.

Properties

ClrCredentialv1p1

ClrCredentialv1p1

A ClrCredential is a CLR with all the properties needed to conform with a Verifiable Credential as defined in the [[VC-DATA-MODEL]].

Subclass Of:
VerifiableCredentialv1p1.

Properties

ClrSubject

ClrSubject

A collection of information about the learner that is the subject of this CLR credential.

Subclass Of:
CredentialSubject.

Properties

ClrSubjectJwtPayload

ClrSubjectJwtPayload

Claims about the subject learner.

Subclass Of:
ClrSubject.

Properties

ClrSubjectv1p1

ClrSubjectv1p1

A collection of information about the learner that is the subject of this CLR credential.

Subclass Of:
CredentialSubject.

Properties

Context

Context

JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied.

Subclass Of:
Map, xsd:anyURI.

Criteria

Criteria

Descriptive metadata about the achievements necessary to be recognized with an assertion of a particular achievement. This data is added to the Achievement class so that it may be rendered when the achievement assertion is displayed, instead of simply a link to human-readable criteria external to the achievement. Embedding criteria allows either enhancement of an external criteria page or increased portability and ease of use by allowing issuers to skip hosting the formerly-required external criteria page altogether. Criteria is used to allow would-be recipients to learn what is required of them to be recognized with an assertion of a particular achievement. It is also used after the assertion is awarded to a recipient to let those inspecting earned achievements know the general requirements that the recipients met in order to earn it.

Properties

EndorsementCredential

EndorsementCredential

A verifiable credential that asserts a claim about an entity. As described in data-integrity, at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.

Subclass Of:
VerifiableCredential.

Properties

EndorsementCredentialv1p1

EndorsementCredentialv1p1

A verifiable credential that asserts a claim about an entity. As described in data-integrity, at least one proof mechanism, and the details necessary to evaluate that proof, MUST be expressed for a credential to be a verifiable credential. In the case of an embedded proof, the credential MUST append the proof in the `proof` property.

Subclass Of:
VerifiableCredentialv1p1.

Properties

EndorsementSubject

EndorsementSubject

A collection of information about the subject of the endorsement.

Subclass Of:
CredentialSubject.

Properties

Evidence

Evidence

Descriptive metadata about evidence related to the achievement assertion. Each instance of the evidence class present in an assertion corresponds to one entity, though a single entry can describe a set of items collectively. There may be multiple evidence entries referenced from an assertion. The narrative property is also in scope of the assertion class to provide an overall description of the achievement related to the assertion in rich text. It is used here to provide a narrative of achievement of the specific entity described. If both the description and narrative properties are present, displayers can assume the narrative value goes into more detail and is not simply a recapitulation of description.

Properties

GeoCoordinates

GeoCoordinates

The geographic coordinates of a location.

Properties

GetClrCredentialsResponse

GetClrCredentialsResponse

Can't find any description.

Properties

IdentifierEntry

IdentifierEntry

Can't find any description.

Properties

IdentifierType

IdentifierType

Can't find any description.

Properties

IdentityObject

IdentityObject

A collection of information about the recipient of an achievement.

Properties

Image

Image

Metadata about images that represent assertions, achieve or profiles. These properties can typically be represented as just the id string of the image, but using a fleshed-out document allows for including captions and other applicable metadata.

Properties

JWK

JWK

A JSON Web Key (JWK) formatted according to [[RFC7517]].

Properties

JWKS

JWKS

A JWK Set (JWKS) formatted according to [[RFC7517]].

Properties

Map

Map

A map representing an object with unknown, arbitrary properties

Multikey

Multikey

Can't find any description.

Properties

Profile

Profile

A Profile is a collection of information that describes the entity or organization using Open Badges. Issuers must be represented as Profiles, and endorsers, or other entities may also be represented using this vocabulary. Each Profile that represents an Issuer may be referenced in many BadgeClasses that it has defined. Anyone can create and host an Issuer file to start issuing Open Badges. Issuers may also serve as recipients of Open Badges, often identified within an Assertion by specific properties, like their url or contact email address.

Properties

ProfileRef

ProfileRef

A description of the individual, entity, or organization that issued the credential. Either a URI with the Unique URI for the Issuer/Profile file, or a Profile object MUST be supplied.

Subclass Of:
Profile, xsd:anyURI.

Profilev1p1

Profilev1p1

A Profile is a collection of information that describes the entity or organization using Open Badges. Issuers must be represented as Profiles, and endorsers, or other entities may also be represented using this vocabulary. Each Profile that represents an Issuer may be referenced in many BadgeClasses that it has defined. Anyone can create and host an Issuer file to start issuing Open Badges. Issuers may also serve as recipients of Open Badges, often identified within an Assertion by specific properties, like their url or contact email address.

Properties

Result

Result

Describes a result that was achieved.

Properties

ResultDescription

ResultDescription

Describes a possible achievement result.

Properties

RubricCriterionLevel

RubricCriterionLevel

Describes a rubric criterion level.

Properties

Property definitions

This section contains information about all the JSON-LD properties used in 1EdTech Comprehensive Learner Record Standard

achievedLevel

achievedLevel

If the result represents an achieved rubric criterion level (e.g. Mastered), the value is the `id` of the RubricCriterionLevel in linked ResultDescription.

Range:
xsd:anyURI
Domain:
Result

achievement

achievement

In AchievementSubject:The achievement being awarded.

In AchievementSubjectv1p1:The achievement being awarded.

In ClrSubject:The set of achievements the CLR issuer expects the learner to achieve.

In ClrSubjectv1p1:The set of achievements the CLR issuer expects the learner to achieve.

Range:
Union of:
Achievementv1p1
Achievement
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1
ClrSubject
ClrSubjectv1p1

achievementType

achievementType

In Achievement:The type of achievement. This is an extensible vocabulary.

In Achievementv1p1:The type of achievement. This is an extensible vocabulary.

Range:
xsd:string
Domain:
Union of:
Achievement
Achievementv1p1

activityEndDate

activityEndDate

In AchievementSubject:The datetime the activity ended.

In AchievementSubjectv1p1:The datetime the activity ended.

Range:
xsd:dateTime
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

activityStartDate

activityStartDate

In AchievementSubject:The datetime the activity started.

In AchievementSubjectv1p1:The datetime the activity started.

Range:
xsd:dateTime
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

additionalName

additionalName

In Profile:Additional name. Includes what is often referred to as 'middle name' in the western world.

In Profilev1p1:Additional name. Includes what is often referred to as 'middle name' in the western world.

Range:
https://schema.org/additionalName
Domain:
Union of:
Profile
Profilev1p1

address

address

In Profile:An address for the individual or organization.

In Profilev1p1:An address for the individual or organization.

Range:
Address
Domain:
Union of:
Profile
Profilev1p1

addressCountry

addressCountry

A country.

Range:
https://schema.org/addressCountry
Domain:
Address

addressCountryCode

addressCountryCode

A country code. The value must be a ISO 3166-1 alpha-2 country code [[ISO3166-1]].

Range:
xsd:string
Domain:
Address

addressLocality

addressLocality

A locality within the region.

Range:
https://schema.org/addressLocality
Domain:
Address

addressRegion

addressRegion

A region within the country.

Range:
https://schema.org/addressRegion
Domain:
Address

alg

alg

The `alg` (algorithm) parameter identifies the algorithm intended for use with the key, such as `RS256` or `PS256`.

Range:
xsd:string
Domain:
JWK

alignment

alignment

In Achievement:An object describing which objectives or educational standards this achievement aligns to, if any.

In Achievementv1p1:An object describing which objectives or educational standards this achievement aligns to, if any.

In Result:The alignments between this result and nodes in external frameworks. This set of alignments are in addition to the set of alignments defined in the corresponding ResultDescription object.

In ResultDescription:Alignments between this result description and nodes in external frameworks.

In RubricCriterionLevel:Alignments between this rubric criterion level and a rubric criterion levels defined in external frameworks.

Range:
Alignment
Domain:
Union of:
Achievement
Achievementv1p1
Result
ResultDescription
RubricCriterionLevel

allowedValue

allowedValue

An ordered list of allowed values. The values should be ordered from low to high as determined by the achievement creator.

Range:
xsd:string
Domain:
ResultDescription

association

association

In ClrSubject:Associations describe the semantic relationship between source and target achievements and their assertions.

In ClrSubjectv1p1:Associations describe the semantic relationship between source and target achievements and their assertions.

Range:
Association
Domain:
Union of:
ClrSubject
ClrSubjectv1p1

associationType

associationType

The type of relationship between a source achievement and a target achievement. For example the source achievement is the child of the target achievement.

Range:
xsd:string
Domain:
Association

audience

audience

A description of the intended audience for a piece of evidence.

Range:
https://schema.org/audience
Domain:
Evidence

awardedDate

awardedDate

In AchievementCredential:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.

In AchievementCredentialv1p1:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.

In ClrCredential:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.

In ClrCredentialv1p1:Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.

In EndorsementCredential:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.

In EndorsementCredentialv1p1:Timestamp of when the credential was awarded. `validFrom` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `validFrom`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.

Range:
xsd:dateTime
Domain:
Union of:
AchievementCredential
AchievementCredentialv1p1
ClrCredential
ClrCredentialv1p1
EndorsementCredential
EndorsementCredentialv1p1

caption

caption

The caption for the image.

Range:
https://schema.org/caption
Domain:
Image

compactJwsString

compactJwsString

ClrCredentials that have been signed with the VC-JWT Proof Format MUST be in the `compactJwsString` array.

Range:
xsd:string
Domain:
GetClrCredentialsResponse

controller

controller

The identify of the entity that controls this public key.

Range:
xsd:anyURI
Domain:
Multikey

creator

creator

In Achievement:The person or organization that created the achievement definition.

In Achievementv1p1:The person or organization that created the achievement definition.

Range:
Union of:
Profilev1p1
Profile
Domain:
Union of:
Achievement
Achievementv1p1

credential

credential

ClrCredentials that have not been signed with the VC-JWT Proof Format MUST be in the `credential` array.

Range:
ClrCredential
Domain:
GetClrCredentialsResponse

credentialSubject

credentialSubject

In AchievementCredential:The recipient of the achievement.

In AchievementCredentialv1p1:The recipient of the achievement.

In ClrCredential:The learner that is the subject of this CLR credential.

In ClrCredentialJwtPayload:Claims about the learner.

In ClrCredentialv1p1:The learner that is the subject of this CLR credential.

In EndorsementCredential:The individual, entity, organization, assertion, or achievement that is endorsed and the endorsement comment.

In EndorsementCredentialv1p1:The individual, entity, organization, assertion, or achievement that is endorsed and the endorsement comment.

Range:
Union of:
ClrSubjectJwtPayload
EndorsementSubject
ClrSubject
ClrSubjectv1p1
AchievementSubject
AchievementSubjectv1p1
Domain:
Union of:
AchievementCredential
AchievementCredentialv1p1
ClrCredential
ClrCredentialJwtPayload
ClrCredentialv1p1
EndorsementCredential
EndorsementCredentialv1p1

creditsAvailable

creditsAvailable

In Achievement:Credit hours associated with this entity, or credit hours possible. For example 3.0.

In Achievementv1p1:Credit hours associated with this entity, or credit hours possible. For example 3.0.

Range:
xsd:float
Domain:
Union of:
Achievement
Achievementv1p1

creditsEarned

creditsEarned

In AchievementSubject:The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.

In AchievementSubjectv1p1:The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.

Range:
xsd:float
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

criteria

criteria

In Achievement:Criteria describing how to earn the achievement.

In Achievementv1p1:Criteria describing how to earn the achievement.

Range:
Criteria
Domain:
Union of:
Achievement
Achievementv1p1

cryptosuite

cryptosuite

The `cryptosuite` of the verification method MUST be the string `eddsa-rdf-2022`.

Range:
xsd:string
Domain:
Multikey

dateOfBirth

dateOfBirth

In Profile:Birthdate of the person.

In Profilev1p1:Birthdate of the person.

Range:
xsd:date
Domain:
Union of:
Profile
Profilev1p1

description

description

In Achievement:A short description of the achievement.

In AchievementCredential:The short description of the credential for display purposes in wallets.

In AchievementCredentialv1p1:The short description of the credential for display purposes in wallets.

In Achievementv1p1:A short description of the achievement.

In ClrCredential:Optional description of the CLR. May be displayed by wallet user interfaces.

In ClrCredentialv1p1:Optional description of the CLR. May be displayed by wallet user interfaces.

In EndorsementCredential:The short description of the credential for display purposes in wallets.

In EndorsementCredentialv1p1:The short description of the credential for display purposes in wallets.

In Evidence:A longer description of the evidence.

In Profile:A short description of the issuer entity or organization.

In Profilev1p1:A short description of the issuer entity or organization.

In RubricCriterionLevel:Description of the rubric criterion level.

Range:
Union of:
https://schema.org/description
Domain:
Union of:
Achievement
AchievementCredential
AchievementCredentialv1p1
Achievementv1p1
ClrCredential
ClrCredentialv1p1
EndorsementCredential
EndorsementCredentialv1p1
Evidence
Profile
Profilev1p1
RubricCriterionLevel

email

email

In Profile:An email address.

In Profilev1p1:An email address.

Range:
https://schema.org/email
Domain:
Union of:
Profile
Profilev1p1

endorsement

endorsement

In Achievement:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with a Data Integrity proof format.

In AchievementCredential:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with a Data Integrity proof format.

In AchievementCredentialv1p1:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with a Data Integrity proof format.

In Achievementv1p1:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with a Data Integrity proof format.

In ClrCredential:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with a Data Integrity proof format.

In ClrCredentialv1p1:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with a Data Integrity proof format.

In Profile:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with a Data Integrity proof format.

In Profilev1p1:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with a Data Integrity proof format.

Range:
Union of:
EndorsementCredential
EndorsementCredentialv1p1
Domain:
Union of:
Achievement
AchievementCredential
AchievementCredentialv1p1
Achievementv1p1
ClrCredential
ClrCredentialv1p1
Profile
Profilev1p1

endorsementComment

endorsementComment

Allows endorsers to make a simple claim in writing about the entity.

Range:
xsd:string
Domain:
EndorsementSubject

endorsementJwt

endorsementJwt

In Achievement:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with the VC-JWT proof format.

In AchievementCredential:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with the VC-JWT proof format.

In AchievementCredentialv1p1:Allows endorsers to make specific claims about the credential, and the achievement and profiles in the credential. These endorsements are signed with the VC-JWT proof format.

In Achievementv1p1:Allows endorsers to make specific claims about the Achievement. These endorsements are signed with the VC-JWT proof format.

In ClrCredential:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with the VC-JWT proof format.

In ClrCredentialv1p1:Allows endorsers to make specific claims about the ClrCredential, or any AssertionCredential, Achievement, or Profile referenced in the ClrCredential. These endorsements are signed with the VC-JWT proof format.

In Profile:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with the VC-JWT proof format.

In Profilev1p1:Allows endorsers to make specific claims about the individual or organization represented by this profile. These endorsements are signed with the VC-JWT proof format.

Range:
xsd:string
Domain:
Union of:
Achievement
AchievementCredential
AchievementCredentialv1p1
Achievementv1p1
ClrCredential
ClrCredentialv1p1
Profile
Profilev1p1

evidence

evidence

In AchievementCredential:A description of the work that the recipient did to earn the achievement. This can be a page that links out to other pages if linking directly to the work is infeasible.

In AchievementCredentialv1p1:Can't find any description.

Range:
Evidence
Domain:
Union of:
AchievementCredential
AchievementCredentialv1p1

familyName

familyName

In Profile:Family name. In the western world, often referred to as the 'last name' of a person.

In Profilev1p1:Family name. In the western world, often referred to as the 'last name' of a person.

Range:
https://schema.org/familyName
Domain:
Union of:
Profile
Profilev1p1

familyNamePrefix

familyNamePrefix

In Profile:Family name prefix. As used in some locales, this is the leading part of a family name (e.g. 'de' in the name 'de Boer').

In Profilev1p1:Family name prefix. As used in some locales, this is the leading part of a family name (e.g. 'de' in the name 'de Boer').

Range:
xsd:string
Domain:
Union of:
Profile
Profilev1p1

fieldOfStudy

fieldOfStudy

In Achievement:Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.

In Achievementv1p1:Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.

Range:
xsd:string
Domain:
Union of:
Achievement
Achievementv1p1

genre

genre

A string that describes the type of evidence. For example, Poetry, Prose, Film.

Range:
https://schema.org/genre
Domain:
Evidence

geo

geo

The geographic coordinates of the location.

Range:
GeoCoordinates
Domain:
Address

givenName

givenName

In Profile:Given name. In the western world, often referred to as the 'first name' of a person.

In Profilev1p1:Given name. In the western world, often referred to as the 'first name' of a person.

Range:
https://schema.org/givenName
Domain:
Union of:
Profile
Profilev1p1

hashed

hashed

Whether or not the `identityHash` value is hashed.

Range:
xsd:boolean
Domain:
IdentityObject

honorificPrefix

honorificPrefix

In Profile:Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').

In Profilev1p1:Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').

Range:
https://schema.org/honorificPrefix
Domain:
Union of:
Profile
Profilev1p1

honorificSuffix

honorificSuffix

In Profile:Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').

In Profilev1p1:Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').

Range:
https://schema.org/honorificSuffix
Domain:
Union of:
Profile
Profilev1p1

humanCode

humanCode

In Achievement:The code, generally human readable, associated with an achievement.

In Achievementv1p1:The code, generally human readable, associated with an achievement.

Range:
xsd:string
Domain:
Union of:
Achievement
Achievementv1p1

identifier

identifier

In AchievementSubject:Other identifiers for the recipient of the achievement. Either `id` or at least one `identifier` MUST be supplied.

In AchievementSubjectv1p1:Other identifiers for the recipient of the achievement. Either `id` or at least one `identifier` MUST be supplied.

In AnyIdentifier:An identifier.

In ClrSubject:Other identifiers for the recipient of the CLR credential. Either `id` or at least one `identifier`is required.

In ClrSubjectv1p1:Other identifiers for the recipient of the CLR credential. Either `id` or at least one `identifier`is required.

In IdentifierEntry:An identifier.

Range:
Union of:
IdentityObject
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1
AnyIdentifier
ClrSubject
ClrSubjectv1p1
IdentifierEntry

identifierType

identifierType

In IdentifierEntry:The identifier type.

In IdentifierType:The identifier type.

Range:
xsd:string
Domain:
Union of:
IdentifierEntry
IdentifierType

identityHash

identityHash

Either the IdentityHash of the identity or the plaintext value. If it's possible that the plaintext transmission and storage of the identity value would leak personally identifiable information where there is an expectation of privacy, it is strongly recommended that an IdentityHash be used.

Range:
xsd:string
Domain:
IdentityObject

identityType

identityType

The identity type.

Range:
xsd:string
Domain:
IdentityObject

image

image

In Achievement:An image representing the achievement.

In AchievementCredential:The image representing the credential for display purposes in wallets.

In AchievementCredentialv1p1:The image representing the credential for display purposes in wallets.

In AchievementSubject:An image representing this user's achievement. If present, this must be a PNG or SVG image, and should be prepared via the 'baking' instructions. An 'unbaked' image for the achievement is defined in the Achievement class and should not be duplicated here.

In AchievementSubjectv1p1:An image representing this user's achievement. If present, this must be a PNG or SVG image, and should be prepared via the 'baking' instructions. An 'unbaked' image for the achievement is defined in the Achievement class and should not be duplicated here.

In Achievementv1p1:An image representing the achievement.

In ClrCredential:Optional image representing the CLR. May be displayed by wallet user interfaces. If present, MUST represent a PNG or SVG image. MAY be a 'baked' image.

In ClrCredentialv1p1:Optional image representing the CLR. May be displayed by wallet user interfaces. If present, MUST represent a PNG or SVG image. MAY be a 'baked' image.

In Profile:An image representing the issuer. This must be a PNG or SVG image.

In Profilev1p1:An image representing the issuer. This must be a PNG or SVG image.

Range:
Image
Domain:
Union of:
Achievement
AchievementCredential
AchievementCredentialv1p1
AchievementSubject
AchievementSubjectv1p1
Achievementv1p1
ClrCredential
ClrCredentialv1p1
Profile
Profilev1p1

inLanguage

inLanguage

In Achievement:The language of the achievement.

In Achievementv1p1:The language of the achievement.

In Related:The language of the related achievement.

Range:
https://schema.org/inLanguage
Domain:
Union of:
Achievement
Achievementv1p1
Related

key_ops

key_ops

The `key_ops` (key operations) parameter identifies the operation(s) for which the key is intended to be used, such as `sign` (compute digital signature or MAC) or `verify` (verify digital signature or MAC).

Range:
xsd:string
Domain:
JWK

keys

keys

A JWK Set is a JSON object that represents a set of JWKs.

Range:
JWK
Domain:
JWKS

kid

kid

The `kid` (key ID) parameter is used to match a specific key.

Range:
xsd:string
Domain:
JWK

kty

kty

The `kty` (key type) parameter identifies the cryptographic algorithm family used with the key, such as `RSA` or `EC`.

Range:
xsd:string
Domain:
JWK

latitude

latitude

The latitude of the location [[WGS84]].

Range:
https://schema.org/latitude
Domain:
GeoCoordinates

level

level

The rubric performance level in terms of success.

Range:
xsd:string
Domain:
RubricCriterionLevel

licenseNumber

licenseNumber

In AchievementSubject:The license number that was issued with this credential.

In AchievementSubjectv1p1:The license number that was issued with this credential.

Range:
xsd:string
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

longitude

longitude

The longitude of the location [[WGS84]].

Range:
https://schema.org/longitude
Domain:
GeoCoordinates

name

name

In Achievement:The name of the achievement.

In AchievementCredential:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.

In AchievementCredentialv1p1:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.

In Achievementv1p1:The name of the achievement.

In ClrCredential:The name of the CLR. May be displayed by wallet user interfaces.

In ClrCredentialv1p1:The name of the CLR. May be displayed by wallet user interfaces.

In EndorsementCredential:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.

In EndorsementCredentialv1p1:The name of the credential for display purposes in wallets. For example, in a list of credentials and in detail views.

In Evidence:A descriptive title of the evidence.

In Profile:The name of the entity or organization.

In Profilev1p1:The name of the entity or organization.

In ResultDescription:The name of the result.

In RubricCriterionLevel:The name of the rubric criterion level.

Range:
Union of:
https://schema.org/name
Domain:
Union of:
Achievement
AchievementCredential
AchievementCredentialv1p1
Achievementv1p1
ClrCredential
ClrCredentialv1p1
EndorsementCredential
EndorsementCredentialv1p1
Evidence
Profile
Profilev1p1
ResultDescription
RubricCriterionLevel

narrative

narrative

In AchievementSubject:A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.

In AchievementSubjectv1p1:A narrative that connects multiple pieces of evidence. Likely only present at this location if evidence is a multi-value array.

In Criteria:A narrative of what is needed to earn the achievement. Markdown is allowed.

In Evidence:A narrative that describes the evidence and process of achievement that led to an assertion.

Range:
xsd:string
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1
Criteria
Evidence

official

official

In Profile:If the entity is an organization, `official` is the name of an authorized official of the organization.

In Profilev1p1:If the entity is an organization, `official` is the name of an authorized official of the organization.

Range:
xsd:string
Domain:
Union of:
Profile
Profilev1p1

otherIdentifier

otherIdentifier

In Achievement:A list of identifiers for the described entity.

In Achievementv1p1:A list of identifiers for the described entity.

In Profile:A list of identifiers for the described entity.

In Profilev1p1:A list of identifiers for the described entity.

Range:
IdentifierEntry
Domain:
Union of:
Achievement
Achievementv1p1
Profile
Profilev1p1

parentOrg

parentOrg

In Profile:The parent organization of the entity.

In Profilev1p1:The parent organization of the entity.

Range:
Profile
Domain:
Union of:
Profile
Profilev1p1

partial

partial

In ClrCredential:True if CLR does not contain all the assertions known by the publisher for the learner at the time the CLR is issued. Useful if you are sending a small set of achievements in real time when they are achieved. If False or omitted, the CLR SHOULD be interpreted as containing all the assertions for the learner known by the publisher at the time of issue.

In ClrCredentialv1p1:True if CLR does not contain all the assertions known by the publisher for the learner at the time the CLR is issued. Useful if you are sending a small set of achievements in real time when they are achieved. If False or omitted, the CLR SHOULD be interpreted as containing all the assertions for the learner known by the publisher at the time of issue.

Range:
xsd:boolean
Domain:
Union of:
ClrCredential
ClrCredentialv1p1

patronymicName

patronymicName

In Profile:Patronymic name.

In Profilev1p1:Patronymic name.

Range:
xsd:string
Domain:
Union of:
Profile
Profilev1p1

phone

phone

In Profile:A phone number.

In Profilev1p1:A phone number.

Range:
xsd:string
Domain:
Union of:
Profile
Profilev1p1

points

points

The points associated with this rubric criterion level.

Range:
xsd:string
Domain:
RubricCriterionLevel

postOfficeBoxNumber

postOfficeBoxNumber

A post office box number for PO box addresses.

Range:
https://schema.org/postOfficeBoxNumber
Domain:
Address

postalCode

postalCode

A postal code.

Range:
https://schema.org/postalCode
Domain:
Address

publicKeyMultibase

publicKeyMultibase

The `publicKeyMultibase` property of the verification method MUST be a public key encoded according to [?MULTICODEC] and formatted according to [?MULTIBASE]. The multicodec encoding of a Ed25519 public key is the two-byte prefix `0xed01` followed by the 32-byte public key data.

Range:
xsd:string
Domain:
Multikey

requiredLevel

requiredLevel

The `id` of the rubric criterion level required to pass as determined by the achievement creator.

Range:
xsd:anyURI
Domain:
ResultDescription

requiredValue

requiredValue

A value from `allowedValue` or within the range of `valueMin` to `valueMax` required to pass as determined by the achievement creator.

Range:
xsd:string
Domain:
ResultDescription

result

result

In AchievementSubject:The set of results being asserted.

In AchievementSubjectv1p1:The set of results being asserted.

Range:
Result
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

resultDescription

resultDescription

In Achievement:The set of result descriptions that may be asserted as results with this achievement.

In Achievementv1p1:The set of result descriptions that may be asserted as results with this achievement.

In Result:An achievement can have many result descriptions describing possible results. The value of `resultDescription` is the `id` of the result description linked to this result. The linked result description must be in the achievement that is being asserted.

Range:
Union of:
ResultDescription
Domain:
Union of:
Achievement
Achievementv1p1
Result

resultType

resultType

The type of result this description represents. This is an extensible enumerated vocabulary.

Range:
xsd:string
Domain:
ResultDescription

role

role

In AchievementSubject:Role, position, or title of the learner when demonstrating or performing the achievement or evidence of learning being asserted. Examples include 'Student President', 'Intern', 'Captain', etc.

In AchievementSubjectv1p1:Role, position, or title of the learner when demonstrating or performing the achievement or evidence of learning being asserted. Examples include 'Student President', 'Intern', 'Captain', etc.

Range:
xsd:string
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

rubricCriterionLevel

rubricCriterionLevel

An ordered array of rubric criterion levels that may be asserted in the linked result. The levels should be ordered from low to high as determined by the achievement creator.

Range:
RubricCriterionLevel
Domain:
ResultDescription

salt

salt

If the `identityHash` is hashed, this should contain the string used to salt the hash. If this value is not provided, it should be assumed that the hash was not salted.

Range:
xsd:string
Domain:
IdentityObject

source

source

In AchievementSubject:The person, organization, or system that assessed the achievement on behalf of the issuer. For example, a school may assess the achievement, while the school district issues the credential.

In AchievementSubjectv1p1:The person, organization, or system that assessed the achievement on behalf of the issuer. For example, a school may assess the achievement, while the school district issues the credential.

Range:
Union of:
Profilev1p1
Profile
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

sourceId

sourceId

The `id` of the source achievement.

Range:
xsd:anyURI
Domain:
Association

specialization

specialization

In Achievement:Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.

In Achievementv1p1:Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.

Range:
xsd:string
Domain:
Union of:
Achievement
Achievementv1p1

status

status

The status of the achievement. Required if `resultType` of the linked ResultDescription is Status.

Range:
xsd:string
Domain:
Result

streetAddress

streetAddress

A street address within the locality.

Range:
https://schema.org/streetAddress
Domain:
Address

tag

tag

In Achievement:One or more short, human-friendly, searchable, keywords that describe the type of achievement.

In Achievementv1p1:One or more short, human-friendly, searchable, keywords that describe the type of achievement.

Range:
https://schema.org/keywords
Domain:
Union of:
Achievement
Achievementv1p1

targetCode

targetCode

If applicable, a locally unique string identifier that identifies the alignment target within its framework and/or targetUrl.

Range:
xsd:string
Domain:
Alignment

targetDescription

targetDescription

Short description of the alignment target.

Range:
https://schema.org/targetDescription
Domain:
Alignment

targetFramework

targetFramework

Name of the framework the alignment target.

Range:
xsd:string
Domain:
Alignment

targetId

targetId

The `id` of the target achievement.

Range:
xsd:anyURI
Domain:
Association

targetName

targetName

Name of the alignment.

Range:
https://schema.org/targetName
Domain:
Alignment

targetType

targetType

The type of the alignment target node.

Range:
xsd:string
Domain:
Alignment

targetUrl

targetUrl

URL linking to the official description of the alignment target, for example an individual standard within an educational framework.

Range:
xsd:anyURI
Domain:
Alignment

term

term

In AchievementSubject:The academic term in which this assertion was achieved.

In AchievementSubjectv1p1:The academic term in which this assertion was achieved.

Range:
xsd:string
Domain:
Union of:
AchievementSubject
AchievementSubjectv1p1

url

url

In Profile:The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.

In Profilev1p1:The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.

Range:
xsd:anyURI
Domain:
Union of:
Profile
Profilev1p1

use

use

The `use` (public key use) parameter identifies the intended use of the public key, such as `sig` (signature) or `end` (encryption).

Range:
xsd:string
Domain:
JWK

value

value

A string representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received an A grade in class.

Range:
https://schema.org/value
Domain:
Result

valueMax

valueMax

The maximum possible `value` that may be asserted in a linked result.

Range:
xsd:string
Domain:
ResultDescription

valueMin

valueMin

The minimum possible `value` that may be asserted in a linked result.

Range:
xsd:string
Domain:
ResultDescription

verifiableCredential

verifiableCredential

In ClrSubject:A set of AchievementCredentials, OpenBadgeCredentials, and other VerifiableCredentials the learner has been awarded. The credential issuers may not be the same entity as the ClrCredential issuer, but the ClrCredential's credential subject is guaranteed to be the same person as the credential subject of each included credential, even if they use different identifiers.

In ClrSubjectJwtPayload:The set of achievements the publisher claims have been awarded to the learner in Compact JWS format. The CLR issuer publisher may not be the same entity as the assertion issuers, but the CLR subject MUST be the same entity as the assertion subjects even if they have different indentifiers.

In ClrSubjectv1p1:A set of AchievementCredentials, OpenBadgeCredentials, and other VerifiableCredentials the learner has been awarded. The credential issuers may not be the same entity as the ClrCredential issuer, but the ClrCredential's credential subject is guaranteed to be the same person as the credential subject of each included credential, even if they use different identifiers.

Range:
Union of:
Domain:
Union of:
ClrSubject
ClrSubjectJwtPayload
ClrSubjectv1p1

version

version

In Achievement:The version property allows issuers to set a version string for an Achievement. This is particularly useful when replacing a previous version with an update.

In Achievementv1p1:The version property allows issuers to set a version string for an Achievement. This is particularly useful when replacing a previous version with an update.

In Related:The version of the related achievement.

Range:
xsd:string
Domain:
Union of:
Achievement
Achievementv1p1
Related

x5c

x5c

The `x5c` (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [[RFC5280]].

Range:
xsd:string
Domain:
JWK

x5t

x5t

The `x5t` (X.509 certificate SHA-1 thumbprint) parameter is a base64url-encoded SHA-1 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate [[RFC5280]].

Range:
xsd:string
Domain:
JWK

x5t_S256

x5t_S256

The `x5t#S256` (X.509 certificate SHA-256 thumbprint) parameter is a base64url-encoded SHA-256 thumbprint (a.k.a. digest) of the DER encoding of an X.509 certificate [[RFC5280]].

Range:
xsd:string
Domain:
JWK

x5u

x5u

The `x5u` (X.509 URL) parameter is a URI that refers to a resource for an X.509 public key certificate or certificate chain [[RFC5280]].

Range:
xsd:anyURI
Domain:
JWK