IMS ClrService Context Description Notes
IMS Final Release
Version 1.0
This is the set of term definitions for the ClrService context.
The Comprehensive Learner Record Standard provides information about a user and their achievements.
List of Properties
Class Definitions
An accomplishment such as completing a degree, mastering a competency, or course completion that may be asserted about one or more learners.
The list and definition of the child properties is:-
- id
- Globally unique IRI for the Achievement. If the IRI is a URL it must resolve to an Achievement resource.
- type
- The JSON-LD type of this object. Normally 'Achievement'.
- achievementType
- A CLR Achievement can represent many different types of achievement from an assessment result to membership. Use 'Achievement' to indicate an achievement not in the list of allowed values.
- alignments
- Alignment objects describe an alignment between this achievement and a node in an educational framework.
- associations
- Associations between this achievement and other achievements.
- creditsAvailable
- Credit hours associated with this entity, or credit hours possible. For example '3.0'.
- description
- A short description of the achievement. May be the same as name if no description is available.
- endorsements
- Allows endorsers to make specific claims about the Achievement.
- humanCode
- The code, generally human readable, associated with an achievement.
- identifiers
- A set of System Identifiers that represent other identifiers for this Achievement.
- name
- The name of the achievement.
- fieldOfStudy
- Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.
- image
- IRI of an image representing the achievement. May be a Data URI or the URL where the image may be found.
- issuer
- A profile describing the individual or organization that issues assertions of this achievement.
- level
- Text that describes the level of achievement apart from how the achievement was performed or demonstrated. Examples would include 'Level 1', 'Level 2', 'Level 3', or 'Bachelors', 'Masters', 'Doctoral'.
- requirement
- Criteria object describing how to earn the achievement.
- resultDescriptions
- The set of result descriptions that may be asserted as results with this achievement.
- signedEndorsements
- Signed endorsements in JWS Compact Serialization format.
- specialization
- Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include Entrepreneurship, Technical Communication, and Finance.
- tags
- Tags that describe the type of achievement.
- extensions
- The Achievement object can be extended with additional properties.
Based on schema.org Address object.
The list and definition of the child properties is:-
- id
- Unique IRI for the Address.
- type
- The JSON-LD type of this object. Normally 'Address'.
- addressCountry
- The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
- addressLocality
- The locality. For example, Mountain View.
- addressRegion
- The region. For example, CA.
- postalCode
- The postal code. For example, 94043.
- postOfficeBoxNumber
- The post office box number for PO box addresses.
- streetAddress
- The street address. For example, 1600 Amphitheatre Pkwy.
- extensions
- The Address object can be extended with additional properties.
Alignment is based on the schema.org AlignmentObject.
The list and definition of the child properties is:-
- id
- Unique IRI for the object.
- type
- The JSON-LD type of this entity. Normally 'Alignment'.
- targetCode
- If applicable, a locally unique string identifier that identifies the alignment target within its framework.
- targetDescription
- The description of a node in an established educational framework.
- targetName
- The name of a node in an established educational framework.
- targetFramework
- The name of the framework to which the resource being described is aligned.
- targetType
- The type of the alignment target node. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.
- targetUrl
- The URL of a node in an established educational framework. When the alignment is to a CASE framework and the CASE Service support the CASE JSON-LD binding, the URL should be the 'uri' of the node document, otherwise the URL should be the CASE Service endpoint URL that returns the node JSON.
- extensions
- The Alignment object can be extended with additional properties.
An artifact that is part of an evidence object.
The list and definition of the child properties is:-
- type
- The JSON-LD type of the object. Normally 'Artifact'.
- description
- A description of the artifact.
- name
- The name of the artifact.
- url
- IRI of the artifact. May be a Data URI or the URL where the artifact may be found.
- extensions
- The Artifact object can be extended with additional properties.
Assertions are representations of an Achievement awarded to a Learner. It is used to share information about the Achievement Assertion, such as a result and verification method. Assertions are packaged for transmission as JSON objects with a set of mandatory and optional properties.
The list and definition of the child properties is:-
- id
- Globally unique IRI for the Assertion. If the IRI is a URL it must resolve to an Assertion resource. If the Assertion is verified using Hosted verification, the IRI must be a URL.
- type
- The JSON-LD type of this object. Normally 'Assertion'.
- achievement
- Required unless the assertion is an Open Badge.
- activityEndDate
- If present, end date for the activity.
- activityStartDate
- If present, start date for the activity.
- creditsEarned
- The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement creditsAvailable field.
- endorsements
- Allows endorsers to make specific claims about the assertion.
- evidence
- Evidence describing the work that the recipient did to earn the achievement. This can be a webpage that links out to other pages if linking directly to the work is infeasible.
- expires
- If the achievement has some notion of expiry, this indicates a timestamp when an assertion should no longer be considered valid. After this time, the assertion should be considered expired.
- image
- IRI of an image representing the assertion. May be a Data URI or the URL where the image may be found.
- issuedOn
- Timestamp of when the achievement was awarded. Required unless the assertion is revoked.
- licenseNumber
- The license number that was issued with this assertion.
- narrative
- A narrative that describes the connection between multiple pieces of evidence. Likely only present if evidence is a multi-value array. Markdown allowed.
- recipient
- The recipient of the achievement. Required unless the assertion is revoked.
- results
- The set of results being asserted.
- revocationReason
- Optional published reason for revocation, if revoked.
- revoked
- Defaults to false if this assertion is not referenced in a RevocationList. If revoked is true, only revoked and id are required properties, and many issuers strip a hosted assertion down to only those properties when revoked.
- role
- 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.
- signedEndorsements
- Signed endorsements in JWS Compact Serialization format.
- source
- The person, organization, or system that assessed the achievement. The Achievement issuer is responsible for supporting verification.
- term
- The academic term in which this assertion was achieved.
- verification
- Instructions for third parties to verify this assertion.
- extensions
- The Assertion object can be extended with additional properties.
Association is based on the CASE AssociationLink object. An Association associates (relates) one Achievement with another Achievement.
The list and definition of the child properties is:-
- associationType
- The type of association. This uses an enumerated vocabulary.
- targetId
- The '@id' of another achievement, or target of the association.
- title
- A human readable title for the associated achievement.
- extensions
- The Association object can be extended with additional properties.
A collection of assertions for a single person reported by a single publisher.
The list and definition of the child properties is:-
- id
- Globally unique IRI for the CLR. If the IRI is a URL is must resolve to a CLR resource and conform to the getClr endpoint format. If the CLR is verified using Hosted verification, the IRI must be a URL.
- type
- The JSON-LD type of this object. Normally 'Clr'.
- achievements
- Array of achievements that are related directly or indirectly through associations with the asserted achievements in the CLR. Primarily used to represent hierarchical pathways. Asserted achievements may appear in both this array and in the achievement assertion. If asserted achievements do appear in both places, they MUST match exactly.
- assertions
- The learner's asserted achievements.
- endorsements
- Allows endorsers to make specific claims about the CLR, or any assertion, achievement, or profile referenced in the CLR.
- issuedOn
- Timestamp of when the CLR was published.
- learner
- The profile describing the recipient of the achievement assertions.
- name
- Optional name of the CLR.
- partial
- 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.
- publisher
- A profile describing the publisher of the CLR.
- revocationReason
- If revoked, optional reason for revocation.
- revoked
- If True the CLR is revoked.
- signedAssertions
- Signed assertions in JWS Compact Serialization format.
- signedEndorsements
- Signed endorsements of the CLR or any Achievement, Assertion, or Profile in the CLR; in JWS Compact Serialization format.
- verification
- Instructions for third parties to verify this CLR.
- extensions
- The Clr object can be extended with additional properties.
The data-type for a JSON Web Signature (JWS) in Compact format.
Descriptive metadata about the achievements necessary to be recognized with an Assertion of a particular AchievementType. This data is added to the AchievementType so that it may be rendered when that AchievementType is displayed, instead of simply a link to human-readable criteria external to the Achievement Assertion. 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.
The list and definition of the child properties is:-
- id
- The URI of a webpage that describes the criteria for the Achievement in a human-readable format.
- type
- The JSON-LD type of this object. Normally 'Criteria'.
- narrative
- A narrative of what is needed to earn the achievement. Markdown allowed.
- extensions
- The Criteria object can be extended with additional properties.
Based on the Key class from the W3C Web Payments Community Group Security Vocabulary. A CryptographicKey document identifies and describes a public key used to verify signed Assertions.
The list and definition of the child properties is:-
- id
- The URI of the CryptographicKey document. Used during signed verification.
- type
- The JSON-LD type of this object. Normally 'CryptographicKey'.
- owner
- The identifier for the Profile that owns this PUBLIC KEY and the PRIVATE KEY used to sign the assertion or endorsement.
- publicKeyPem
- The PUBLIC KEY in PEM format corresponding to the PRIVATE KEY used by the owner to sign the assertion or endorsement. The PEM key encoding is a widely-used method to express public keys, compatible with almost every Secure Sockets Layer library implementation.
- extensions
- The CryptographicKey object can be extended with additional properties.
An endorsement claim.
The list and definition of the child properties is:-
- id
- Globally unique IRI for the Endorsement. If this Endorsement will be verified using Hosted verification, the value should be the URL of the hosted version of the Endorsement.
- type
- The JSON-LD type of this entity. Normally 'Endorsement'.
- claim
- An entity, identified by an id and additional properties that the endorser would like to claim about that entity.
- issuedOn
- Timestamp of when the endorsement was published.
- issuer
- The issuer's Profile.
- revocationReason
- If revoked, optional reason for revocation.
- revoked
- If True the endorsement is revoked.
- verification
- Instructions for third parties to verify this assertion of endorsement.
- extensions
- The Endorsement object can be extended with additional properties.
An entity, identified by an id and additional properties that the endorser would like to claim about that entity.
The list and definition of the child properties is:-
- id
- The 'id' of the Profile, Achievement, Assertion, or CLR being endorsed.
- type
- The JSON-LD type of this entity. Normally 'EndorsementClaim'.
- endorsementComment
- An endorser's comment about the quality or fitness of the endorsed entity. Markdown allowed.
- extensions
- The EndorsementClaim object can be extended with additional properties.
A Profile is a collection of information that describes the person or organization using Comprehensive Learner Record (CLR). Publishers, learners, and issuers must be represented as profiles. Recipients, endorsers, or other entities may also be represented using this vocabulary. An EndorsementProfile cannot have endorsements.
The list and definition of the child properties is:-
- id
- Globally unique IRI for the Profile.
- type
- The JSON-LD type of this entity. Normally 'Profile'. Unlike the Profile object, the EndorsementProfile object does not have an 'endorsements' property.
- additionalName
- An additional name for a person, can be used for a middle name.
- address
- An address for the individual or organization.
- description
- A short description of the individual or organization.
- email
- A contact email address for the individual or organization.
- familyName
- Family name of a person. In the U.S., the last name of a person.
- givenName
- Given name of a person. In the U.S., the first name of a person.
- identifiers
- A set of System Identifiers that represent other identifiers for this Profile.
- image
- Image representing the individual or organization.
- name
- The full name of the individual or organization.
- official
- The name of the authorized official for the Issuer.
- publicKey
- The CryptographicKey object used to verify signed Assertions, Clrs, and Endorsements.
- revocationList
- The URL of the Revocation List document used for marking revocation of signed Assertions, CLRs, and Endorsements. Required for issuer profiles.
- sourcedId
- The individual's unique 'sourcedId' value, which is used for providing interoperability with IMS Learning Information Services (LIS).
- studentId
- An institution's student identifier for the person. This is frequently issued through a Student Information System.
- telephone
- Primary phone number for the individual or organization.
- url
- Web resource that uniquely represents or belongs to the individual. This may be a resource about the individual, hosting provided by the institution to the individual, or an web resource independently controlled by the individual.
- verification
- Instructions for how to verify Assertion issued by this Profile.
- extensions
- The EndorsementProfile object can be extended with additional properties.
The data-type that enables an enumerated vocabulary to be extended.
One or more artifacts that represent supporting evidence for the record. Examples include text, media, websites, etc.
The list and definition of the child properties is:-
- id
- The URI of a webpage presenting evidence of achievement.
- type
- The JSON-LD type of this entity. Normally 'Evidence'.
- artifacts
- Artifacts that are part of the evidence.
- audience
- A description of the intended audience for a piece of evidence.
- description
- A longer description of the evidence.
- genre
- A string that describes the type of evidence. For example, Poetry, Prose, Film.
- name
- The name of the evidence.
- narrative
- A narrative that describes the evidence and process of achievement that led to an assertion. Markdown allowed.
- extensions
- The Evidence object can be extended with additional properties.
The type of achievement. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.
The list and definition of the child properties is:-
- Achievement
- Represents a generic achievement.
- Assessment
- Represents the result of a skill, competency, or outcome-based summative assessment.
- Assignment
- Represents the result of a curricular, or co-curricular assignment or exam.
- Award
- Represents an award.
- Badge
- Represents a generic badge. Set the type to 'BadgeClass' and reference the IMS Open Badges @context file if the achievement is an IMS Open Badges achievement.
- Certificate
- Represents a credit bearing certificate such as an undergraduate certificate in autism.
- Certification
- Represents a non-credit certification such as a CompTIA certification in IT.
- Course
- Represents a course completion.
- CommunityService
- Represents community service.
- Competency
- Represents a competency.
- Co-Curricular
- Represents a co-curricular activity.
- Degree
- Represents a degree.
- Diploma
- Represents a diploma such as a high school diploma in the United States.
- Fieldwork
- Represents practical activities that are done away school, college, or place of work. Includes internships and practicums.
- License
- Represents a license.
- Membership
- Represents membership.
- ...tbc (Generalization Attribute-Derived)...
- ...tbc (Generalization Description-Derived)...
The type of the alignment target node. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.
The list and definition of the child properties is:-
- ...tbc (Generalization Attribute-Derived)...
- ...tbc (Generalization Description-Derived)...
- CFItem
- An alignment to a CASE Framework Item.
- CFRubric
- An alignment to a CASE Framework Rubric.
- CFRubricCriterion
- An alignment to a CASE Framework Rubric Criterion.
- CFRubricCriterionLevel
- An alignment to a CASE Framework Rubric Criterion Level.
- CTDL
- An alignment to a Credential Engine Item.
The type of result. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.
The list and definition of the child properties is:-
- ...tbc (Generalization Attribute-Derived)...
- ...tbc (Generalization Description-Derived)...
- GradePointAverage
- The result is a grade point average.
- LetterGrade
- The result is a letter grade.
- Percent
- The result is a percent score.
- PerformanceLevel
- The result is a performance level.
- PredictedScore
- The result is a predicted score.
- Result
- Represents a generic result.
- RawScore
- The result is a raw score.
- RubricCriterion
- The result is from a rubric criterion.
- RubricCriterionLevel
- The result is a rubric criterion level.
- RubricScore
- The result represents a rubric score with both a name and a numeric value.
- ScaledScore
- The result is a scaled score.
- Status
- The result conveys the status of the achievement.
The type of the 'identifier' property of SystemIdentifier. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention. For example, the NCES School ID might be 'ext:NcesSchoolId'. Extended vocabulary terms must start with 'ext:' followed by any valid JSON string value. Please see the latest version of the CLR Implementation Guide for suggested values.
The list and definition of the child properties is:-
- LisSourcedId
- The IMS LIS sourcedId for the achievement represented by the Achievement instance or the IMS LIS sourcedId for the person or organization represented by the Profile instance.
- OneRosterSourcedId
- The IMS OneRoster sourcedId for the achievement represented by the Achievement instance or the IMS OneRoster sourcedId for the person or organization represented by the Profile instance.
- ...tbc (Generalization Attribute-Derived)...
- ...tbc (Generalization Description-Derived)...
The internationalized resource identifier (IRI) is an internet protocol standard which extends the ASCII characters subset of the Uniform Resource Identifier (URI) protocol.
A collection of information about the recipient of an achievement assertion.
The list and definition of the child properties is:-
- id
- Unique IRI for the Identity.
- type
- The type should identify the property by which the recipient of an Assertion is identified. This value should be an IRI mapped in the present context. For example, 'id' indicates that the identity property value is the id of the recipient's profile.
- identity
- Either the hash 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.
- hashed
- Whether or not the identity value is hashed.
- salt
- If the recipient 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.
- extensions
- The Identity object can be extended with additional properties.
Text that may contain formatting according to Markdown syntax. Due to uneven support in displayers, publishers are encouraged to limit usage to simple elements like links, emphasis, and lists. Displayers may choose a subset of Markdown formatting to support or how to render this field. Images and tables may or may not be supported.
A Profile is a collection of information that describes the person or organization using Comprehensive Learner Record (CLR). Publishers, learners, and issuers must be represented as profiles. Recipients, endorsers, or other entities may also be represented using this vocabulary.
The list and definition of the child properties is:-
- id
- Globally unique IRI for the Learner, Publisher, and Issuer Profile. If the IRI is a URL it must resolve to a Profile resource. The Assertion Recipient is identified by reference to the Learner's Profile via the id, email, url, telephone, sourcedId, or studentId property.
- type
- The JSON-LD type of this object. Normally 'Profile'.
- address
- An address for the individual or organization.
- additionalName
- An additional name for a person, can be used for a middle name.
- birthDate
- Birthdate of the person.
- description
- A short description of the individual or organization.
- email
- A contact email address for the individual or organization.
- endorsements
- Allows endorsers to make specific claims about the individual or organization represented by this profile.
- familyName
- Family name of a person. In the U.S., the last name of a person.
- givenName
- Given name of a person. In the U.S., the first name of a person.
- identifiers
- A set of System Identifiers that represent other identifiers for this Profile.
- image
- IRI of an image representing the individual or organization. May be a DATA URI or the URL where the image may be found.
- name
- The full name of the individual or organization.
- official
- The name of the authorized official for the Issuer.
- parentOrg
- The parent organization of the person or organization represented by this organization.
- publicKey
- The CryptographicKey object used to verify signed Assertions, Clrs, and Endorsements.
- revocationList
- The URL of the Revocation List document used for marking revocation of signed Assertions, CLRs, and Endorsements. Required for issuer profiles.
- signedEndorsements
- Signed endorsements in JWS Compact Serialization format.
- sourcedId
- The individual's or organization's unique 'sourcedId' value, which is used for providing interoperability with other identity systems.
- studentId
- An institution's student identifier for the person. This is frequently issued through a Student Information System.
- telephone
- Primary phone number for the individual or organization.
- url
- Web resource that uniquely represents or belongs to the individual. This may be a resource about the individual, hosting provided by the institution to the individual, or an web resource independently controlled by the individual.
- verification
- Issuer and publisher profiles should have a verification property with a type of 'Verification'. Instructions for how to verify assertions and endorsements issued by the individual or organization represented by this profile.
- extensions
- The Profile object can be extended with additional properties.
Describes a result of an achievement.
The list and definition of the child properties is:-
- id
- Unique IRI for the object.
- type
- The JSON-LD type of this object. Normally 'Result'.
- achievedLevel
- The id of the RubricCriterionLevel achieved.
- alignments
- 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.
- resultDescription
- The id of the ResultDescription describing this result.
- status
- The status of the achievement. Required if 'ResultType' is 'Status'.
- value
- A grade or value representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received a grade of A in the class.
- extensions
- The Result object can be extended with additional properties.
Describes a possible achievement result.
The list and definition of the child properties is:-
- id
- Unique IRI for the ResultDescription.
- type
- The JSON-LD type of this object. Normally 'ResultDescription'.
- alignments
- The alignments between this result description and nodes in external frameworks.
- allowedValues
- The ordered from 'low' to 'high' set of allowed values.
- name
- The name of the result.
- requiredLevel
- The id of the RubricCriterionLevel required to 'pass'.
- requiredValue
- The value from allowedValues or within the range of valueMin to valueMax required to 'pass'.
- resultType
- The type of result. This is an extensible enumerated vocabulary.
- rubricCriterionLevels
- The ordered from 'low' to 'high' set of rubric criterion levels that may be asserted.
- valueMax
- The maximum possible result that may be asserted.
- valueMin
- The minimum possible result that may be asserted.
- extensions
- The ResultDescription object can be extended with additional properties.
The Revocation List is a document that describes Assertions and Endorsements an Issuer has revoked that used the signed verification method. If you find the Assertion or Endorsement in the revokedAssertions list, it has been revoked.
The list and definition of the child properties is:-
- id
- The URI of the RevocationList document. Used during Signed verification.
- type
- The JSON-LD type of this entity. Normally 'RevocationList'.
- issuer
- The id of the Issuer.
- revokedAssertions
- The ids of revoked Assertions, Clrs, and Endorsements.
Describes a rubric criterion level.
The list and definition of the child properties is:-
- id
- Unique IRI for the ResultCriterionLevel.
- type
- The JSON-LD type of this object. Normally 'RubricCriterionLevel'.
- alignments
- The alignments between this rubric criterion level and nodes in external frameworks.
- description
- A description of the rubric criterion level.
- level
- The rubric performance level in terms of success.
- name
- The name of the RubricCriterionLevel.
- points
- The number of grade points corresponding to a specific rubric level.
- extensions
- The RubricCriterionLevel object can be extended with additional properties.
A SystemIdentifier represents a single, system-local identifier for an Achievement.
The list and definition of the child properties is:-
- type
- The JSON-LD type of this object. Normally 'SystemIdentifier'.
- identifier
- Opaque string representing the system identifier value.
- identifierType
- The identifier type. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention. For example, the NCES School ID might be 'ext:NcesSchoolId'. Extended vocabulary terms must start with 'ext:' followed by any valid JSON string value. Please see the latest version of the CLR Implementation Guide for suggested values.
- extensions
- The SystemIdentifier class can be extended with additional properties.
The data-type for establishing a Globally Unique Identifier (GUID). The form of the GUID is a Universally Unique Identifier (UUID) of 16 hexadecimal characters (lower case) in the format 8-4-4-4-12. All permitted versions (1-5) and variants (1-2) are supported.
Information a reviewer can use to verify an Assertion, Clr, or Endorsement.
The list and definition of the child properties is:-
- id
- Unique IRI for the Verification.
- type
- The JSON-LD type of this object. The strongly typed value indicates the verification method.
- allowedOrigins
- The host registered name subcomponent of an allowed origin. Any given id URI will be considered valid.
- creator
- The (HTTP) id of the key used to sign the Assertion, CLR, or Endorsement. If not present, verifiers will check the public key declared in the referenced issuer Profile. If a key is declared here, it must be authorized in the issuer Profile as well. creator is expected to be the dereferencable URI of a document that describes a CryptographicKey.
- startsWith
- The URI fragment that the verification property must start with. Valid Assertions, Clrs, and Endorsements must have an id within this scope. Multiple values allowed, and Assertions, Clrs, and Endorsements will be considered valid if their id starts with one of these values.
- verificationProperty
- The property to be used for verification. Only 'id' is supported. Verifiers will consider 'id' the default value if verificationProperty is omitted or if an issuer Profile has no explicit verification instructions, so it may be safely omitted.
- extensions
- The Verification object can be extended with additional properties.
Property Definitions
This property is used in the following classes:-
- dtGetAssertionPayload Class
- The JSON-LD @context.
- dtGetClrPayload Class
- The JSON-LD @context.
- dtGetCryptographicKeyPayload Class
- The JSON-LD @context.
- dtGetEndorsementPayload Class
- The JSON-LD @context.
- dtGetRevocationListPayload Class
- The JSON-LD @context.
The id of the RubricCriterionLevel achieved.
Required unless the assertion is an Open Badge.
A CLR Achievement can represent many different types of achievement from an assessment result to membership. Use 'Achievement' to indicate an achievement not in the list of allowed values.
Array of achievements that are related directly or indirectly through associations with the asserted achievements in the CLR. Primarily used to represent hierarchical pathways. Asserted achievements may appear in both this array and in the achievement assertion. If asserted achievements do appear in both places, they MUST match exactly.
This property is used in the following classes:-
- dtAssertion Class
- If present, end date for the activity.
This property is used in the following classes:-
- dtAssertion Class
- If present, start date for the activity.
This property is used in the following classes:-
- dtEndorsementProfile Class
- An additional name for a person, can be used for a middle name.
- dtProfile Class
- An additional name for a person, can be used for a middle name.
An address for the individual or organization.
This property is used in the following classes:-
- dtAddress Class
- The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
This property is used in the following classes:-
- dtAddress Class
- The locality. For example, Mountain View.
This property is used in the following classes:-
- dtAddress Class
- The region. For example, CA.
Alignment objects describe an alignment between this achievement and a node in an educational framework.
This property is used in the following classes:-
- dtVerification Class
- The host registered name subcomponent of an allowed origin. Any given id URI will be considered valid.
This property is used in the following classes:-
- dtResultDescription Class
- The ordered from 'low' to 'high' set of allowed values.
Artifacts that are part of the evidence.
The learner's asserted achievements.
The type of association. This uses an enumerated vocabulary.
Associations between this achievement and other achievements.
This property is used in the following classes:-
- dtEvidence Class
- A description of the intended audience for a piece of evidence.
This property is used in the following classes:-
- dtDiscoveryDocument Class
- A fully qualifed URL to the provider's OAuth 2.0 Authorization endpoint.
This property is used in the following classes:-
- dtProfile Class
- Birthdate of the person.
An entity, identified by an id and additional properties that the endorser would like to claim about that entity.
The Clr if not signed.
A set of Clrs
This property is used in the following classes:-
- dtVerification Class
- The (HTTP) id of the key used to sign the Assertion, CLR, or Endorsement. If not present, verifiers will check the public key declared in the referenced issuer Profile. If a key is declared here, it must be authorized in the issuer Profile as well. creator is expected to be the dereferencable URI of a document that describes a CryptographicKey.
This property is used in the following classes:-
- dtAchievement Class
- Credit hours associated with this entity, or credit hours possible. For example '3.0'.
This property is used in the following classes:-
- dtAssertion Class
- The number of credits earned, generally in semester or quarter credit hours. This field correlates with the Achievement creditsAvailable field.
This property is used in the following classes:-
- dtAchievement Class
- A short description of the achievement. May be the same as name if no description is available.
- dtArtifact Class
- A description of the artifact.
- dtEndorsementProfile Class
- A short description of the individual or organization.
- dtEvidence Class
- A longer description of the evidence.
- dtProfile Class
- A short description of the individual or organization.
- dtRubricCriterionLevel Class
- A description of the rubric criterion level.
This property is used in the following classes:-
- dtEndorsementProfile Class
- A contact email address for the individual or organization.
- dtProfile Class
- A contact email address for the individual or organization.
An endorser's comment about the quality or fitness of the endorsed entity. Markdown allowed.
Allows endorsers to make specific claims about the Achievement.
Evidence describing the work that the recipient did to earn the achievement. This can be a webpage that links out to other pages if linking directly to the work is infeasible.
This property is used in the following classes:-
- dtAssertion Class
- If the achievement has some notion of expiry, this indicates a timestamp when an assertion should no longer be considered valid. After this time, the assertion should be considered expired.
This property is used in the following classes:-
- dtAchievement Class
- The Achievement object can be extended with additional properties.
- dtAddress Class
- The Address object can be extended with additional properties.
- dtAlignment Class
- The Alignment object can be extended with additional properties.
- dtArtifact Class
- The Artifact object can be extended with additional properties.
- dtAssertion Class
- The Assertion object can be extended with additional properties.
- dtAssociation Class
- The Association object can be extended with additional properties.
- dtClr Class
- The Clr object can be extended with additional properties.
- dtCriteria Class
- The Criteria object can be extended with additional properties.
- dtCryptographicKey Class
- The CryptographicKey object can be extended with additional properties.
- dtEndorsement Class
- The Endorsement object can be extended with additional properties.
- dtEndorsementClaim Class
- The EndorsementClaim object can be extended with additional properties.
- dtEndorsementProfile Class
- The EndorsementProfile object can be extended with additional properties.
- dtEvidence Class
- The Evidence object can be extended with additional properties.
- dtIdentity Class
- The Identity object can be extended with additional properties.
- dtProfile Class
- The Profile object can be extended with additional properties.
- dtResult Class
- The Result object can be extended with additional properties.
- dtResultDescription Class
- The ResultDescription object can be extended with additional properties.
- dtRubricCriterionLevel Class
- The RubricCriterionLevel object can be extended with additional properties.
- dtSystemIdentifier Class
- The SystemIdentifier class can be extended with additional properties.
- dtVerification Class
- The Verification object can be extended with additional properties.
This property is used in the following classes:-
- dtEndorsementProfile Class
- Family name of a person. In the U.S., the last name of a person.
- dtProfile Class
- Family name of a person. In the U.S., the last name of a person.
This property is used in the following classes:-
- dtAchievement Class
- Category, subject, area of study, discipline, or general branch of knowledge. Examples include Business, Education, Psychology, and Technology.
This property is used in the following classes:-
- dtEvidence Class
- A string that describes the type of evidence. For example, Poetry, Prose, Film.
This property is used in the following classes:-
- dtEndorsementProfile Class
- Given name of a person. In the U.S., the first name of a person.
- dtProfile Class
- Given name of a person. In the U.S., the first name of a person.
This property is used in the following classes:-
- dtIdentity Class
- Whether or not the identity value is hashed.
This property is used in the following classes:-
- dtAchievement Class
- The code, generally human readable, associated with an achievement.
Globally unique IRI for the Achievement. If the IRI is a URL it must resolve to an Achievement resource.
This property is used in the following classes:-
- dtSystemIdentifier Class
- Opaque string representing the system identifier value.
The identifier type. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention. For example, the NCES School ID might be 'ext:NcesSchoolId'. Extended vocabulary terms must start with 'ext:' followed by any valid JSON string value. Please see the latest version of the CLR Implementation Guide for suggested values.
A set of System Identifiers that represent other identifiers for this Achievement.
This property is used in the following classes:-
- dtIdentity Class
- Either the hash 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.
IRI of an image representing the achievement. May be a Data URI or the URL where the image may be found.
This property is used in the following classes:-
- dtAssertion Class
- Timestamp of when the achievement was awarded. Required unless the assertion is revoked.
- dtClr Class
- Timestamp of when the CLR was published.
- dtEndorsement Class
- Timestamp of when the endorsement was published.
A profile describing the individual or organization that issues assertions of this achievement.
The profile describing the recipient of the achievement assertions.
This property is used in the following classes:-
- dtAchievement Class
- Text that describes the level of achievement apart from how the achievement was performed or demonstrated. Examples would include 'Level 1', 'Level 2', 'Level 3', or 'Bachelors', 'Masters', 'Doctoral'.
- dtRubricCriterionLevel Class
- The rubric performance level in terms of success.
This property is used in the following classes:-
- dtAssertion Class
- The license number that was issued with this assertion.
This property is used in the following classes:-
- dtAchievement Class
- The name of the achievement.
- dtArtifact Class
- The name of the artifact.
- dtClr Class
- Optional name of the CLR.
- dtDiscoveryDocument Class
- The user-facing name of the platform providing CLR services.
- dtEndorsementProfile Class
- The full name of the individual or organization.
- dtEvidence Class
- The name of the evidence.
- dtProfile Class
- The full name of the individual or organization.
- dtResultDescription Class
- The name of the result.
- dtRubricCriterionLevel Class
- The name of the RubricCriterionLevel.
A narrative that describes the connection between multiple pieces of evidence. Likely only present if evidence is a multi-value array. Markdown allowed.
This property is used in the following classes:-
- dtEndorsementProfile Class
- The name of the authorized official for the Issuer.
- dtProfile Class
- The name of the authorized official for the Issuer.
The identifier for the Profile that owns this PUBLIC KEY and the PRIVATE KEY used to sign the assertion or endorsement.
The parent organization of the person or organization represented by this organization.
This property is used in the following classes:-
- dtClr Class
- 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.
This property is used in the following classes:-
- dtRubricCriterionLevel Class
- The number of grade points corresponding to a specific rubric level.
This property is used in the following classes:-
- dtAddress Class
- The post office box number for PO box addresses.
This property is used in the following classes:-
- dtAddress Class
- The postal code. For example, 94043.
This property is used in the following classes:-
- dtDiscoveryDocument Class
- A fully qualified URL to the provider's privacy policy.
The CryptographicKey object used to verify signed Assertions, Clrs, and Endorsements.
This property is used in the following classes:-
- dtCryptographicKey Class
- The PUBLIC KEY in PEM format corresponding to the PRIVATE KEY used by the owner to sign the assertion or endorsement. The PEM key encoding is a widely-used method to express public keys, compatible with almost every Secure Sockets Layer library implementation.
A profile describing the publisher of the CLR.
The recipient of the achievement. Required unless the assertion is revoked.
This property is used in the following classes:-
- dtDiscoveryDocument Class
- A fully qualified URL to the provider's OAuth 2.0 Registration endpoint.
The id of the RubricCriterionLevel required to 'pass'.
This property is used in the following classes:-
- dtResultDescription Class
- The value from allowedValues or within the range of valueMin to valueMax required to 'pass'.
Criteria object describing how to earn the achievement.
The id of the ResultDescription describing this result.
The set of result descriptions that may be asserted as results with this achievement.
The type of result. This is an extensible enumerated vocabulary.
The set of results being asserted.
This property is used in the following classes:-
- dtEndorsementProfile Class
- The URL of the Revocation List document used for marking revocation of signed Assertions, CLRs, and Endorsements. Required for issuer profiles.
- dtProfile Class
- The URL of the Revocation List document used for marking revocation of signed Assertions, CLRs, and Endorsements. Required for issuer profiles.
This property is used in the following classes:-
- dtAssertion Class
- Optional published reason for revocation, if revoked.
- dtClr Class
- If revoked, optional reason for revocation.
- dtEndorsement Class
- If revoked, optional reason for revocation.
This property is used in the following classes:-
- dtAssertion Class
- Defaults to false if this assertion is not referenced in a RevocationList. If revoked is true, only revoked and id are required properties, and many issuers strip a hosted assertion down to only those properties when revoked.
- dtClr Class
- If True the CLR is revoked.
- dtEndorsement Class
- If True the endorsement is revoked.
The ids of revoked Assertions, Clrs, and Endorsements.
This property is used in the following classes:-
- dtAssertion Class
- 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.
The ordered from 'low' to 'high' set of rubric criterion levels that may be asserted.
This property is used in the following classes:-
- dtIdentity Class
- If the recipient 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.
This property is used in the following classes:-
- dtDiscoveryDocument Class
- An array of OAuth 2.0 Scopes supported by the provider.
Signed assertions in JWS Compact Serialization format.
The signed Clr in JWS Compact Serialization format.
A set of Clrs in JWS Compact Serialization format.
Signed endorsements in JWS Compact Serialization format.
The person, organization, or system that assessed the achievement. The Achievement issuer is responsible for supporting verification.
This property is used in the following classes:-
- dtEndorsementProfile Class
- The individual's unique 'sourcedId' value, which is used for providing interoperability with IMS Learning Information Services (LIS).
- dtProfile Class
- The individual's or organization's unique 'sourcedId' value, which is used for providing interoperability with other identity systems.
This property is used in the following classes:-
- dtAchievement Class
- Name given to the focus, concentration, or specific area of study defined in the achievement. Examples include Entrepreneurship, Technical Communication, and Finance.
This property is used in the following classes:-
- dtVerification Class
- The URI fragment that the verification property must start with. Valid Assertions, Clrs, and Endorsements must have an id within this scope. Multiple values allowed, and Assertions, Clrs, and Endorsements will be considered valid if their id starts with one of these values.
The status of the achievement. Required if 'ResultType' is 'Status'.
This property is used in the following classes:-
- dtAddress Class
- The street address. For example, 1600 Amphitheatre Pkwy.
This property is used in the following classes:-
- dtEndorsementProfile Class
- An institution's student identifier for the person. This is frequently issued through a Student Information System.
- dtProfile Class
- An institution's student identifier for the person. This is frequently issued through a Student Information System.
This property is used in the following classes:-
- dtAchievement Class
- Tags that describe the type of achievement.
This property is used in the following classes:-
- dtAlignment Class
- If applicable, a locally unique string identifier that identifies the alignment target within its framework.
This property is used in the following classes:-
- dtAlignment Class
- The description of a node in an established educational framework.
This property is used in the following classes:-
- dtAlignment Class
- The name of the framework to which the resource being described is aligned.
The '@id' of another achievement, or target of the association.
This property is used in the following classes:-
- dtAlignment Class
- The name of a node in an established educational framework.
The type of the alignment target node. This is an extensible enumerated vocabulary. Extending the vocabulary makes use of a naming convention.
This property is used in the following classes:-
- dtAlignment Class
- The URL of a node in an established educational framework. When the alignment is to a CASE framework and the CASE Service support the CASE JSON-LD binding, the URL should be the 'uri' of the node document, otherwise the URL should be the CASE Service endpoint URL that returns the node JSON.
This property is used in the following classes:-
- dtEndorsementProfile Class
- Primary phone number for the individual or organization.
- dtProfile Class
- Primary phone number for the individual or organization.
This property is used in the following classes:-
- dtAssertion Class
- The academic term in which this assertion was achieved.
This property is used in the following classes:-
- dtDiscoveryDocument Class
- A fully qualified URL to the provider's terms of service.
This property is used in the following classes:-
- dtAssociation Class
- A human readable title for the associated achievement.
This property is used in the following classes:-
- dtDiscoveryDocument Class
- A fully qualified URL to the provider's OAuth 2.0 Token endpoint.
The JSON-LD type of this object. Normally 'Achievement'.
IRI of the artifact. May be a Data URI or the URL where the artifact may be found.
This property is used in the following classes:-
- dtResult Class
- A grade or value representing the result of the performance, or demonstration, of the achievement. For example, 'A' if the recipient received a grade of A in the class.
This property is used in the following classes:-
- dtResultDescription Class
- The maximum possible result that may be asserted.
This property is used in the following classes:-
- dtResultDescription Class
- The minimum possible result that may be asserted.
Instructions for third parties to verify this assertion.
This property is used in the following classes:-
- dtVerification Class
- The property to be used for verification. Only 'id' is supported. Verifiers will consider 'id' the default value if verificationProperty is omitted or if an issuer Profile has no explicit verification instructions, so it may be safely omitted.