Skip to main content

:Credential

CONTEXT: object.informational.education.credential

An Educational Credential is a document or certificate proving a person's education level or qualifications. It can be a diploma, academic degree, certification, qualification, badge, or a public or private document affirming the learning outcome, achievement, competence, or status of an individual, issued by an education institution or a recognized authority.

Educational Credential Data Structure

FieldTypeDescriptionMandatoryReference
credentialImageCDIDID of credental image (resource)No
credentialTypeEnumType of the credential (e.g., Diploma, Degree, Certificate)Yes
subjectStringSubject or field of study for the credentialYes
levelEnumLevel of the credential (e.g., Undergraduate, Graduate)No
titleObtainedStringTitle obtained from the credential, if anyNo
moduleRefCDIDReference to the education moduleYes
issuedByCDIDEntity/Actor that issued the credentialYes
issuedToCDIDActor that earned this credentialYes
issuedForCDIDEntity/Actor for whom the module is organizedNo
startTimeDateStart time of the education periodNo
endTimeDateEnd time of the education periodNo
dateIssuedDateDate when the credential was issuedYes
teacherStringTeacher that was holding the lecturesNo
teacherRefCDIDActor (Teacher) that was holding the lecturesNo
scoreEnumScore or grade achieved, if applicableNo
scorePointsNumberScore or grade achieved, if applicableNo

Example

{
"credentialType": "Degree",
"subject": "Computer Science",
"level": "Undergraduate",
"titleObtained": "Bachelor of Science in Computer Science",
"moduleRef": "3f293f29-4466-4607-8bd8-6f202e2b8e51",
"issuedBy": "b7d6e1e8-669a-4e33-b3d6-1b0bfa2c8791",
"issuedTo": "3f293f29-4466-4607-8bd8-6f202e2b8e51",
"issuedFor": "b7d6e1e8-669a-4e33-b3d6-1b0bfa2c8791",
"startTime": "2019-09-01",
"endTime": "2020-06-01",
"dateIssued": "2020-06-01",
"teacher": "Professor XYZ",
"teacherRef": "b7d6e1e8-669a-4e33-b3d6-1b0bfa2c8791",
"score": "HighDistinction",
"scorePoints": 5.0
}

Enums

CredentialType

enum CredentialType {
Diploma = 'Diploma',
Degree = 'Degree',
Certificate = 'Certificate',
AdvancedDiploma = 'AdvancedDiploma',
AssociateDegree = 'AssociateDegree',
BachelorDegree = 'BachelorDegree',
MasterDegree = 'MasterDegree',
DoctorateDegree = 'DoctorateDegree',
ProfessionalCertification = 'ProfessionalCertification',
VocationalQualification = 'VocationalQualification',
}

Level

enum Level {
PrePrimary = 'PrePrimary',
Primary = 'Primary',
Secondary = 'Secondary',
Undergraduate = 'Undergraduate',
Graduate = 'Graduate',
Postgraduate = 'Postgraduate',
Doctorate = 'Doctorate',
PostDoctorate = 'PostDoctorate',
}

Score

enum Score {
Excellent = 'Excellent',
Good = 'Good',
Average = 'Average',
BelowAverage = 'BelowAverage',
Poor = 'Poor',
Failed = 'Failed',
Distinction = 'Distinction',
HighDistinction = 'HighDistinction',
}

Note: These are proposed enum values. They may need to be adjusted based on the specific requirements of your application.