iritmaximus/oodikone
1
0
Fork 0
mirror of https://github.com/UniversityOfHelsinkiCS/oodikone.git synced 2026-10-12 19:03:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Update documentation after deleting some tables in the db

Browse Source
This commit is contained in:
Valtteri Kantanen
2024-09-09 16:46:21 +03:00
parent 2d82c69ee3
commit 7967d10333
2 changed files with 11 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/databases.md
+1 -3
View File
@@ -18,8 +18,6 @@ erDiagram
enrollment }o--|| course : ""
enrollment }o--|| semesters : ""
enrollment }o--|| student : ""
semester_enrollments }o--|| semesters : ""
semester_enrollments }o--|| student : ""
credit_teachers }o--|| teacher : ""
course_types
curriculum_periods
@@ -30,7 +28,7 @@ erDiagram
credit }o--|| student : ""
studyplan }o--|| student : ""
studyplan }o--|| sis_study_rights : ""
sis_study_rights }o--|| study_right_extents : ""
sis_study_rights }o--|| studyright_extents : ""
sis_study_rights }o--|| organization : ""
sis_study_rights }o--|| student : ""
sis_study_right_elements }o--|| sis_study_rights : ""
documentation/numeric_types.md
+10 -31
View File
@@ -4,7 +4,7 @@ Data used in Oodikone contains some numeric types (or _magic numbers_) that are
## Extent code
Appears in model Studyright (db: `studyright`) as _extentcode_ (db: `extentcode`) and in model SISStudyRight (db: `sis_study_rights`) as _extentCode_ (db: `extent_code`). Values are defined in the database table `studyright_extents`.
Appears in model SISStudyRight (db: `sis_study_rights`) as _extentCode_ (db: `extent_code`). Values are defined in the database table `studyright_extents`.
| value | meaning |
| ----: | :-------------------------------------------------- |
@@ -26,33 +26,6 @@ Appears in model Studyright (db: `studyright`) as _extentcode_ (db: `extentcode`
| 34 | Exchange studies (postgraduate studies) |
| 99 | Non-Degree studies |
## Priority code
> [!WARNING]
> Obsolete, to be deprecated
Appears in model Studyright (db: `studyright`) as _prioritycode_ (db: `prioritycode`).
| value | meaning | notes |
| ----: | :-------- | :------------------------------------------------------------------------------------------ |
| 1 | Primary | |
| 2 | Secondary | |
| 5 | Rescinded | seemingly not in use anymore |
| 6 | Option | Ba+Ma students can add a master programme to their study plan before graduating as bachelor |
| 30 | Graduated | |
## Type
> [!WARNING]
> Obsolete, to be deprecated
Appears in model ElementDetails (db: `element_details`) as _type_ (db: `type`).
| value | meaning |
| ----: | :----------------------------------------------- |
| 20 | study programme |
| 30 | module, studytrack or kokonaisuus e.g. neurology |
## Phase
Appears in model SISStudyRightElement (db: `sis_study_right_elements`) as _phase_ (db: `phase`).
@@ -72,7 +45,15 @@ The level of the programme (bachelor's, master's etc.) of the study right can be
## Enrollment type
Appears in model SemesterEnrollment (db: `semester_enrollments`) as _enrollmenttype_ (db: `enrollmenttype`).
This information is used in the model SISStudyRight (db: `sis_study_rights`), in the field _semesterEnrollments_ (db: `semester_enrollments`).
The `semester_enrollments` column is an array of JSON objects. Each object contains:
- `type` (the type of enrollment),
- `semester` (the code for a semester),
- and sometimes `statutoryAbsence` (this field is included only when the enrollment type is 2).
The `type` field represents one of the following enrollment types. The `semester` field refers to a semester code, defined as `semestercode` in the model Semester.
| value | meaning | notes |
| ----: | :------- | :------------------------------- |
@@ -84,8 +65,6 @@ Appears in model SemesterEnrollment (db: `semester_enrollments`) as _enrollmentt
Appears in model Credit (db: `credit`) as _credittypecode_ (db: `credittypecode`). Values are defined in the database table `credit_types`.
Completed/Improved/Transferred/Failed
| value | meaning |
| ----: | :--------------- |
| 4 | Completed |