Webservices: Studiekort

 

Denne webservice returnerer de kursister, der er tilmeldt undervisning med slutDato efter dags dato.

 

Kursister er defineret som aktive, hvis de er tilmeldt undervisning med startDato inden dags dato og SlutDato efter dags dato.

 

 

Til hver kursist er knyttet kursistnummer, navn, klasse, fødselsdato, mailadresse, aktivstatus, hold (liste af tilmeldte undervisningsmoduler og webhold)

 

Til hvert undervisningsmodul er knyttet holdId, holdstart, betegnelse, fag, navn, lærere (liste af lærere tilknyttet undervisningsmodulet fra dags dato og frem)

 

Til hver lærer er knyttet fornavne, initialer og efternavn.

 

 

Servicen kaldes med denne adresse (til erstatning af /ui/main i den sædvanlige adgang til LUDUS Web)): /restServices/studiekort/hent

 

Desuden kan selve formatet hentes via adressen /restServices/studiekort/schema

 

 

 

 

 

 


Oversigt over snitfladen

 

For hver kursist i udtrækket:

 

Felt

 

Bemærkning

 

Navn

 

Fornavne og efternavn

Klasse

 

Null, hvis kursisten ikke er knyttet til en klasse

Fødselsdato

 

Format AAMMDD

 

Mailadresse

 

 

Aktiv

 

Er kursisten tilmeldt igangværende undervisning eller undervisningsperiode

Hold

 

Liste af undervisningsmoduler og webhold, se nedenfor

 

 

 

 

Kursistens undervisningsmoduler:

 

Felt

 

Bemærkning

 

HoldId

 

 

Holdstart

 

 

Betegnelse

 

 

Fag

 

 

Navn

 

 

Lærere

 

Liste af lærere tilknyttet undervisningsmodulet, se nedenfor

 

 

 

 

 

Kursistens webhold:

 

Felt

 

Bemærkning

 

HoldId

 

 

Holdstart

 

 

Betegnelse

 

Webholdets navn

Fag

 

Webholdets fagtype (fx FVU)

Navn

 

For FVU-hold: Fag

For kursushold: Emne

For øvrige webhold: fagtype (fx DU)

 

Lærere

 

Liste af lærere tilknyttet webholdet, se nedenfor

 

 

 

 

 

 

Lærere på undervisningsmodul eller webhold:

 

Felt

 

Bemærkning

 

Fornavn

 

 

Initialer

 

 

Efternavn

 

 

 

 

 

 

 

 

 

Format:

 

{

 "type" : "object",

 "properties" : {

  "studiekort" : {

   "type" : "array", "items" : {

    "type" : "object",

    "properties" : {

     "kursistnummer" : {

      "type" : "integer"

     },

     "navn" : {

      "type" : "string"

     },

     "klasse" : {

      "type" : "string"

     },

     "foedselsdato": {

      "type" : "string"

     },

     "email" : {

      "type" : "string"

     },

     "aktiv" : {

      "type" : "string",

      "enum" : [ "Ja", "Nej" ]

      },

     "hold": {

      "type" : "array",

      "items" : {

       "type" : "object",

       "properties" : {

        "holdId" : {

         "type" : "string"

        },

        "holdStart" : {

         "type" : "string"

        },

        "betegnelse" : {

         "type" : "string"

        },

        "fag" : {

         "type" : "string"

        },

        "navn" : {

         "type" : "string"

        },

        "laerere" : {

         "type" : "array",

         "items" : {

          "type" : "object",

          "properties" : {

           "fornavn" : {

            "type" : "string"

           },

           "initialer" : {

            "type" : "string"

           },

           "efternavn" : {

            "type" : "string"

           }

          }

         }

        }

       }

      }

     }

    }

   }

  }

 }

}