Grade.yaml

Grade:
  type: object
  description: Avser ett registrerat betyg för en elev i ett ämne eller en kurs.
  properties:
    id:
      type: string
      format: uuid
      description: ID för betyget.
    meta:
      $ref: "common.yaml#/Meta"
    student:
      allOf:
        - $ref: "common.yaml#/PersonReference"
        - description: Referens till eleven.
    organisation:
      allOf:
        - $ref: "common.yaml#/SchoolUnitReference"
        - description: Skolenheten där undervisningen genomförts.
    registeredBy:
      allOf:
        - $ref: "common.yaml#/PersonReference"
        - description: Den person som registrerade betyget.
    gradingTeacher:
      allOf:
        - $ref: "common.yaml#/PersonReference"
        - description: Den behöriga lärare som är ansvarig för betyget.
    group:
      allOf:
        - $ref: "common.yaml#/GroupReference"
        - description: Anger vilken grupp eleven ingick i.
    registeredDate:
      type: string
      format: date
      description: Det datum då betyget registrerades (RFC 3339-format, t.ex. "2016-10-15").
    gradeValue:
      type: string
      description: Anger vilket betyg eleven har tilldelats.
    finalGrade:
      type: boolean
      description: >
        Anger om det registrerade betyget är ett slutbetyg för ämnet eller kursen.
    trial:
      type: boolean
      default: false
      description: Anger om betyget satts vid en prövning. Förvalt värde är "false".
    adaptedStudyPlan:
      type: string
      description: >
        Om en specialinriktad ämnesplan (GY) eller anpassad studiegång (GR)
        har använts för kursen så beskrivs här på vilket sätt studiegången anpassats.
    remark:
      type: string
      description: Andra anmärkningar för betygsraden.
    converted:
      type: boolean
      default: false
      description: Anger om betyget är omvandlat. Förvalt värde är "false".
    correctionType:
      type: string
      description: Ändringstyp för betyget, om det är ändrat.
      title: Code_GradeCorrectionType
      enum:
        - Ändring
        - Rättelse
    semester:
      type: string
      description: Om betyget avser höst- eller vårtermin.
      title: Code_Semester
      enum:
        - HT
        - VT
    year:
      type: integer
      description: Året som betyget gäller, exempelvis 2019.
    syllabus:
      $ref: "common.yaml#/SyllabusReference"
    diplomaProject:
      type: object
      properties:
        title:
          type: string
          description: Titel på gymnasiearbete.
        description:
          type: string
          description: Beskrivning av gymnasiearbete.
        titleEngish:
          type: string
          description: Eventuell engelsk titel på gymnasiearbete.
        descriptionEnglish:
          type: string
          description: Eventuell engelsk beskrivning av gymnasiearbete.
      required:
        - title
        - description
  required:
    - id
    - student
    - registeredDate
    - gradeValue
    - syllabus
    - finalGrade
    - adaptedStudyPlan

GradesArray:
    type: array
    items:
      $ref: "#/Grade"


Grades:
 type: object
 properties:
      data:
        type: array
        items:
          $ref: "#/Grade"
      pageToken:
        type: string
        nullable: true
        description: >
          Om värdet är null finns inget mer att hämta på det token
          som skickades in som query parameter.
 required:
    - data