me-enrolment.yaml 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. type: object
  2. description: Enrolment status of a `Lecture Series`
  3. properties:
  4. status:
  5. description: If this enrolment is still active
  6. type: string
  7. oneOf:
  8. - id: enrolled
  9. const: enrolled
  10. description: Currently enrolled, but the lectures have not yet started
  11. - id: active
  12. const: active
  13. description: Enrolled and currently taking part
  14. - id: completed
  15. const: completed
  16. description: Completed the
  17. - id: cancelled
  18. const: cancelled
  19. description: The enrolment was cancelled
  20. - id: failed
  21. const: failed
  22. description: The student failed the module
  23. course_pk:
  24. $ref: ../relations/course.yaml
  25. term_pk:
  26. $ref: ../relations/term.yaml
  27. ects:
  28. $ref: ../common/ects.yaml
  29. mark:
  30. $ref: ../common/mark.yaml
  31. module_pk:
  32. $ref: ../relations/module.yaml
  33. start_date:
  34. description: When this enrolment started (UNIX timestamp in seconds)
  35. type: integer
  36. format: u64
  37. end_date:
  38. description: When this enrolment ended (UNIX timestamp in seconds)
  39. type: integer
  40. format: u64
  41. required:
  42. - status
  43. - course_pk
  44. - term_pk
  45. - ects
  46. - mark
  47. - module_pk
  48. - start_date
  49. - end_date