University of Peradeniya crestSCS Documentation
University of Peradeniya crestSCS Documentation
Department website

Start here

Repository handbookRepository overviewDevelopment

System design

ArchitectureAuthentication and authorizationPublic dataAPI contractsSchemas
Schema referenceAcademic schemasPeople schemasCourse schemasResearch schemasProject schemasAPI transport schemas
UI system

Applications

Department Web applicationPeople applicationProjects applicationPortal application

Services

API serviceGitHub App serviceMailer service

Shared packages

Schemas packageUI packageTypeScript configuration packageESLint configuration package

Development workflow

Testing and verificationDependency managementDocumentation authoringUI quality assurance

Operations

Continuous integrationEnvironment variablesOperationsSecurityTroubleshooting

Reference

Route referenceGlossary
Schema reference

Public schemas for identities, profile records, students, staff variants, social links, and search projections.

People schemas

Identity, profiles, and search

SchemaResponsibility
AcademicUsernameSchemaNormalized institutional username.
SNumberSchemaCanonical undergraduate or special-programme registration number.
PersonSchemaCommon name, title, contact, and profile image fields.
PeopleSearchEntryTypeSchemaStudent or staff search-result kind.
PeopleSearchEntrySchemaSearch projection with identity, route, label, and keywords.
PeopleSearchIndexSchemaComplete array of people search entries.
SocialIconSchemaBuilt-in icon identifier or validated external icon URL.
SocialLinksSchemaNormalized social-profile collection with platform detection rules.

Staff

SchemaResponsibility
AcademicRankSchemaTeaching-staff academic rank.
AcademicTeachingStaffSchemaTeaching profile with department or unit, research, publications, courses, and links.
AcademicSupportPositionSchemaSupported academic-support designation.
AcademicSupportStaffSchemaSupport profile with designation and department or unit.
NonAcademicPositionSchemaSupported non-academic designation.
NonAcademicStaffSchemaNon-academic profile with designation and department or unit.
StaffSchemaDiscriminated union of all three staff profile variants.

Students and directory configuration

SchemaResponsibility
StudentTypeSchemaUndergraduate or postgraduate student kind.
StudentTrackSchemaGeneral or honours undergraduate track.
StudentLevelSchemaUndergraduate level from 1000 through 4000.
StudentStatusSchemaCurrent-student or alumni status.
PostgraduateProgrammeSchemaSupported postgraduate qualification route.
SlqfLevelSchemaSupported Sri Lanka Qualifications Framework level.
StudentStreamSchemaPublic directory stream code.
StudentPlacementSchemaBatch, track, and level placement rule.
StudentPlacementListSchemaPlacement rule collection.
AlumniBatchSchemaAlumni batch and its included tracks.
AlumniBatchListSchemaAlumni-batch rule collection.
PostgraduateProgrammeDefinitionSchemaProgramme label and framework level.
PostgraduateProgrammeDefinitionListSchemaPostgraduate programme definitions.
StudentStreamDefinitionSchemaDirectory label, path, and visibility for a stream.
StudentStreamDefinitionListSchemaStudent-stream definition collection.
StudentSchemaPerson-based student profile with programme-specific cross-field validation.

Honours programme is required only for honours undergraduates. Special-degree subjects are restricted to honours students at the applicable levels; the schema is the authority for these rules, not UI inference.

Academic schemas

Public schemas for academic organizations, subjects, programmes, periods, and years.

Course schemas

Public schemas for courses, offerings, staff assignments, and their canonical identifiers.

On this page

People schemasIdentity, profiles, and searchStaffStudents and directory configuration