This document contains information about the JSON-LD terms used in 1EdTech Open Badges.
Alternate versions of the vocabulary definition exist in Turtle.
This section contains information about all the JSON-LD classes used in 1EdTech Open Badges
Achievement
A collection of information about the accomplishment recognized by the Assertion. Many assertions may be created corresponding to one Achievement.
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]]. 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.
VerifiableCredential.AchievementSubject
A collection of information about the recipient of an achievement. Maps to Credential Subject in [[VC-DATA-MODEL]].
CredentialSubject.Address
An address for the described entity.
Alignment
Describes an alignment between an achievement and a node in an educational framework.
AnyIdentifier
Can't find any description.
Context
JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied.
Map, xsd:anyURI.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.
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.
VerifiableCredential.EndorsementSubject
A collection of information about the subject of the endorsement.
CredentialSubject.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.
GeoCoordinates
The geographic coordinates of a location.
GetOpenBadgeCredentialsResponse
Can't find any description.
IdentifierEntry
Can't find any description.
IdentifierType
Can't find any description.
IdentityObject
A collection of information about the recipient of an achievement.
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.
JWK
A JSON Web Key (JWK) formatted according to [[RFC7517]].
JWKS
A JWK Set (JWKS) formatted according to [[RFC7517]].
Map
A map representing an object with unknown, arbitrary properties
Multikey
Can't find any description.
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.
Related
Identifies a related achievement.
Result
Describes a result that was achieved.
ResultDescription
Describes a possible achievement result.
RubricCriterionLevel
Describes a rubric criterion level.
This section contains information about all the JSON-LD properties used in 1EdTech Open Badges
achievedLevel
If the result represents an achieved rubric criterion level (e.g. Mastered), the value is the `id` of the RubricCriterionLevel in linked ResultDescription.
xsd:anyURIResultachievement
The achievement being awarded.
AchievementAchievementSubjectachievementType
The type of achievement. This is an extensible vocabulary.
xsd:stringAchievementactivityEndDate
The datetime the activity ended.
xsd:dateTimeAchievementSubjectactivityStartDate
The datetime the activity started.
xsd:dateTimeAchievementSubjectadditionalName
Additional name. Includes what is often referred to as 'middle name' in the western world.
https://schema.org/additionalNameProfileaddress
An address for the individual or organization.
AddressProfileaddressCountry
A country.
https://schema.org/addressCountryAddressaddressCountryCode
A country code. The value must be a ISO 3166-1 alpha-2 country code [[ISO3166-1]].
xsd:stringAddressaddressLocality
A locality within the region.
https://schema.org/addressLocalityAddressaddressRegion
A region within the country.
https://schema.org/addressRegionAddressalg
The `alg` (algorithm) parameter identifies the algorithm intended for use with the key, such as `RS256` or `PS256`.
xsd:stringJWKalignment
In Achievement: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.
AlignmentAchievementResultResultDescriptionRubricCriterionLevelallowedValue
An ordered list of allowed values. The values should be ordered from low to high as determined by the achievement creator.
xsd:stringResultDescriptionaudience
A description of the intended audience for a piece of evidence.
https://schema.org/audienceEvidenceawardedDate
In AchievementCredential: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. `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.
xsd:dateTimeAchievementCredentialEndorsementCredentialcaption
The caption for the image.
https://schema.org/captionImagecompactJwsString
OpenBadgeCredentials that have been signed with the VC-JWT Proof Format MUST be in the `compactJwsString` array.
xsd:stringGetOpenBadgeCredentialsResponsecontroller
The identify of the entity that controls this public key.
xsd:anyURIMultikeycreator
The person or organization that created the achievement definition.
ProfileAchievementcredential
OpenBadgeCredentials that have not been signed with the VC-JWT Proof Format MUST be in the `credential` array.
AchievementCredentialGetOpenBadgeCredentialsResponsecredentialSubject
In AchievementCredential:The recipient of the achievement.
In EndorsementCredential:The individual, entity, organization, assertion, or achievement that is endorsed and the endorsement comment.
AchievementSubjectEndorsementSubjectAchievementCredentialEndorsementCredentialcreditsAvailable
Credit hours associated with this entity, or credit hours possible. For example 3.0.
xsd:floatAchievementcreditsEarned
The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement `creditsAvailable` field.
xsd:floatAchievementSubjectcriteria
Criteria describing how to earn the achievement.
CriteriaAchievementcryptosuite
The `cryptosuite` of the verification method MUST be the string `eddsa-rdf-2022`.
xsd:stringMultikeydateOfBirth
Birthdate of the person.
xsd:dateProfiledescription
In Achievement:A short description of the achievement.
In AchievementCredential:The short description of the credential for display purposes in wallets.
In EndorsementCredential: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 RubricCriterionLevel:Description of the rubric criterion level.
https://schema.org/descriptionAchievementAchievementCredentialEndorsementCredentialEvidenceProfileRubricCriterionLevelAn email address.
https://schema.org/emailProfileendorsement
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 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.
EndorsementCredentialAchievementAchievementCredentialProfileendorsementComment
Allows endorsers to make a simple claim in writing about the entity.
xsd:stringEndorsementSubjectendorsementJwt
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 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.
xsd:stringAchievementAchievementCredentialProfileevidence
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.
EvidenceAchievementCredentialfamilyName
Family name. In the western world, often referred to as the 'last name' of a person.
https://schema.org/familyNameProfilefamilyNamePrefix
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').
xsd:stringProfilefieldOfStudy
Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.
xsd:stringAchievementgenre
A string that describes the type of evidence. For example, Poetry, Prose, Film.
https://schema.org/genreEvidencegeo
The geographic coordinates of the location.
GeoCoordinatesAddressgivenName
Given name. In the western world, often referred to as the 'first name' of a person.
https://schema.org/givenNameProfilehashed
Whether or not the `identityHash` value is hashed.
xsd:booleanIdentityObjecthonorificPrefix
Honorific prefix(es) preceding a person's name (e.g. 'Dr', 'Mrs' or 'Mr').
https://schema.org/honorificPrefixProfilehonorificSuffix
Honorific suffix(es) following a person's name (e.g. 'M.D, PhD').
https://schema.org/honorificSuffixProfilehumanCode
The code, generally human readable, associated with an achievement.
xsd:stringAchievementidentifier
In AchievementSubject:Other identifiers for the recipient of the achievement. Either `id` or at least one `identifier` MUST be supplied.
In AnyIdentifier:An identifier.
In IdentifierEntry:An identifier.
IdentityObjectAchievementSubjectAnyIdentifierIdentifierEntryidentifierType
In IdentifierEntry:The identifier type.
In IdentifierType:The identifier type.
xsd:stringIdentifierEntryIdentifierTypeidentityHash
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.
xsd:stringIdentityObjectidentityType
The identity type.
xsd:stringIdentityObjectimage
In Achievement:An image representing the achievement.
In AchievementCredential: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 Profile:An image representing the issuer. This must be a PNG or SVG image.
ImageAchievementAchievementCredentialAchievementSubjectProfileinLanguage
In Achievement:The language of the achievement.
In Related:The language of the related achievement.
https://schema.org/inLanguageAchievementRelatedkey_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).
xsd:stringJWKkeys
A JWK Set is a JSON object that represents a set of JWKs.
JWKJWKSkid
The `kid` (key ID) parameter is used to match a specific key.
xsd:stringJWKkty
The `kty` (key type) parameter identifies the cryptographic algorithm family used with the key, such as `RSA` or `EC`.
xsd:stringJWKlatitude
The latitude of the location [[WGS84]].
https://schema.org/latitudeGeoCoordinateslevel
The rubric performance level in terms of success.
xsd:stringRubricCriterionLevellicenseNumber
The license number that was issued with this credential.
xsd:stringAchievementSubjectlongitude
The longitude of the location [[WGS84]].
https://schema.org/longitudeGeoCoordinatesname
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 EndorsementCredential: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 ResultDescription:The name of the result.
In RubricCriterionLevel:The name of the rubric criterion level.
https://schema.org/nameAchievementAchievementCredentialEndorsementCredentialEvidenceProfileResultDescriptionRubricCriterionLevelnarrative
In AchievementSubject: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.
xsd:stringAchievementSubjectCriteriaEvidenceofficial
If the entity is an organization, `official` is the name of an authorized official of the organization.
xsd:stringProfileotherIdentifier
In Achievement:A list of identifiers for the described entity.
In Profile:A list of identifiers for the described entity.
IdentifierEntryAchievementProfileparentOrg
The parent organization of the entity.
ProfileProfilepatronymicName
Patronymic name.
xsd:stringProfilephone
A phone number.
xsd:stringProfilepoints
The points associated with this rubric criterion level.
xsd:stringRubricCriterionLevelpostOfficeBoxNumber
A post office box number for PO box addresses.
https://schema.org/postOfficeBoxNumberAddresspostalCode
A postal code.
https://schema.org/postalCodeAddresspublicKeyMultibase
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.
xsd:stringMultikeyrequiredLevel
The `id` of the rubric criterion level required to pass as determined by the achievement creator.
xsd:anyURIResultDescriptionrequiredValue
A value from `allowedValue` or within the range of `valueMin` to `valueMax` required to pass as determined by the achievement creator.
xsd:stringResultDescriptionresult
The set of results being asserted.
ResultAchievementSubjectresultDescription
In Achievement: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.
ResultDescriptionAchievementResultresultType
The type of result this description represents. This is an extensible enumerated vocabulary.
xsd:stringResultDescriptionrole
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.
xsd:stringAchievementSubjectrubricCriterionLevel
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.
RubricCriterionLevelResultDescriptionsalt
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.
xsd:stringIdentityObjectsource
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.
ProfileAchievementSubjectspecialization
Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include 'Entrepreneurship', 'Technical Communication', and 'Finance'.
xsd:stringAchievementstatus
The status of the achievement. Required if `resultType` of the linked ResultDescription is Status.
xsd:stringResultstreetAddress
A street address within the locality.
https://schema.org/streetAddressAddresstag
One or more short, human-friendly, searchable, keywords that describe the type of achievement.
https://schema.org/keywordsAchievementtargetCode
If applicable, a locally unique string identifier that identifies the alignment target within its framework and/or targetUrl.
xsd:stringAlignmenttargetDescription
Short description of the alignment target.
https://schema.org/targetDescriptionAlignmenttargetFramework
Name of the framework the alignment target.
xsd:stringAlignmenttargetName
Name of the alignment.
https://schema.org/targetNameAlignmenttargetType
The type of the alignment target node.
xsd:stringAlignmenttargetUrl
URL linking to the official description of the alignment target, for example an individual standard within an educational framework.
xsd:anyURIAlignmentterm
The academic term in which this assertion was achieved.
xsd:stringAchievementSubjecturl
The homepage or social media profile of the entity, whether individual or institutional. Should be a URL/URI Accessible via HTTP.
xsd:anyURIProfileuse
The `use` (public key use) parameter identifies the intended use of the public key, such as `sig` (signature) or `end` (encryption).
xsd:stringJWKvalue
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.
https://schema.org/valueResultvalueMax
The maximum possible `value` that may be asserted in a linked result.
xsd:stringResultDescriptionvalueMin
The minimum possible `value` that may be asserted in a linked result.
xsd:stringResultDescriptionversion
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 Related:The version of the related achievement.
xsd:stringAchievementRelatedx5c
The `x5c` (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [[RFC5280]].
xsd:stringJWKx5t
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]].
xsd:stringJWKx5t_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]].
xsd:stringJWKx5u
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]].
xsd:anyURIJWK