Activity.yaml

Activity:
  title: Activity
  type: object
  properties:
    id:
      type: string
      format: uuid
      description: Identifierare för aktiviteten.

    meta:
      $ref: "common.yaml#/Meta"

    displayName:
      type: string
      description: Namn på aktiviteten, i presentationssyfte.

    calendarEventsRequired:
      type: boolean
      description: >
        Detta ska uttrycka huruvida aktiviteten ska vara
        underlag för generering av lektion eller inte.

    startDate:
      type: string
      format: date
      description: >
        Datum för när aktiviteten startar
        (RFC 3339-format, t.ex. "2016-10-15").

    endDate:
      type: string
      format: date
      description: >
        Datum för när aktiviteten slutar
        (RFC 3339-format, t.ex. "2016-10-15").

    activityType:
      type: string
      title: Code_ActivityType
      enum:
        - Undervisning
        - Elevaktivitet
        - Provaktivitet
        - Läraraktivitet
        - Övrigt
      description: |
        Beskriver vilken typ av aktivitet som avses.
        * _Undervisning_ - Schemalagd tid med koppling till timplan, som ska närvarorapporteras.
        * _Elevaktivitet_ - Schemalagd tid för elever som inte är undervisning enligt timplan, och som ska närvarorapporteras, exempelvis mentorstid, klassråd eller friluftsdag
        * _Provaktivitet_ - En aktivitet som är avsedd för att definiera ett eller flera provtillfällen
        * _Läraraktivitet_ - Tid för lärare som inte är undervisning och som ingår i lärarens arbetstid, kan vara schemalagd, men ska inte närvarorapporteras, exempelvis konferenstid.
        * _Övrigt_ - Läxhjälp, lunch, bokning och annat som finns på schemat, men inte är undervisning och inte ska närvarorapporteras

    comment:
      type: string
      description: En text med kompletterande information.

    minutesPlanned:
      type: integer
      description: Den totalt planerade tiden i minuter.

    groups:
      type: array
      minItems: 1
      items:
        $ref: "common.yaml#/GroupReference"
      description: De grupper som är kopplade till aktiviteten.

    teachers:
      type: array
      items:
        type: object
        title: DutyAssignment
        properties:
          duty:
            $ref: "common.yaml#/DutyReference"
            required: true
          startDate:
            type: string
            format: date
            description: >
              Datum för när lärarens deltagande i aktiviteten startar
              (RFC 3339-format, t.ex. "2016-10-15").
          endDate:
            type: string
            format: date
            description: >
              Datum för när lärarens deltagande i aktiviteten slutar
              (RFC 3339-format, t.ex. "2016-10-15").
          minutesPlanned:
            type: integer
            description: Det antal minuter läraren är kopplad till aktiviteten
          grader:
            type: boolean
            description: Markerar att läraren har rollen som betygsättande lärare för aktiviteten
      description: De lärare (Duty-objekt) som är kopplade till aktiviteten.

    syllabus:
      allOf:
        - $ref: "common.yaml#/SyllabusReference"
        - description: Det kurs- eller ämnesplan som aktiviteten är knuten till.

    organisation:
      allOf:
        - $ref: "common.yaml#/OrganisationReference"
        - description: Den skolenhet/skola som aktiviteten är knuten till.

    parentActivity:
      allOf:
        - $ref: "common.yaml#/ActivityReference"
        - description: >
            Möjlighet att koppla aktiviteten till en eller flera
            ursprungliga “föräldraaktiviteter”.

  required:
    - id
    - displayName
    - organisation
    - calendarEventsRequired
    - startDate
    - groups

ActivityExpanded:
  allOf:
    - $ref: "#/Activity"
    - type: object
      properties:
        _embedded:
          type: object
          properties:
            groups:
              type: array
              items:
                $ref: "Group.yaml#/Group"
            syllabus:
              $ref: "Syllabus.yaml#/Syllabus"
            teachers:
              type: array
              items:
                $ref: "Duty.yaml#/Duty"

ActivitiesArray:
  type: array
  items:
    $ref: "#/ActivityExpanded"

Activities:
  type: object
  properties:
    data:
      type: array
      items:
        $ref: "#/ActivityExpanded"
    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