Webservice: Publisering af kursuskatalog

WebService_PubliseringAfKursuskatalog
Paw Dybdahl
2012/02/28 09:45

Table of Contents
LudusWeb - WebService_PubliseringAfKursuskatalog
Kursuskatalog webservice ........................................................................................................................................................... 3
Indhold .................................................................................................................................................................................... 3
Snitfladebeskrivelse ................................................................................................................................................................. 3
Ressourcer ............................................................................................................................................................................... 3
Format ..................................................................................................................................................................................... 4
Page 2 - last modified by Paw Dybdahl on 2012/02/28 09:45

Kursuskatalog webservice
Indhold
LudusWeb - WebService_PubliseringAfKursuskatalog
Returnerer skolens samlede kursusudbud for igangværende og kommende kurser (defineret som de undervisningsmoduler, der
har en undervisningsperiode med en slutdato, der ligger efter dagsdato).
Udtrækket medtager skemaet fra én undervisningsperiode: den aktuelle (hvis denne findes og ellers den ældste periode).
Snitfladebeskrivelse
Udtrækket indeholder tre objekter: undervisningmodul, skematime og lærer. Det præcise indhold i hver af disse objekter er
beskrevet nedenfor sammen med en henvisning til, hvor i LUDUS indholdet af det enkelte felt stammer fra.
Undervisningmodul:
Property Felt (i LUDUS) Vindue
holdId Holdid Hold, fanen 'Generelt'
holdStart Holdstart Hold, fanen 'Generelt'
fagKode Fagkode Undervisningsmoduler
holdNavn Navn Hold, fanen 'Generelt'
holdTyper Type(r) Hold, fanen 'Generelt'
maxAntalDeltagere Max. størrelse Undervisningsmoduler
antalDeltagere Akt. (antallet af aktive kursister) Undervisningsmoduler
pris Alt. pris Undervisningsmoduler
alternativPris findes endnu ikke
antalTimerPrUge Lektioner pr.uge Undervisningsperioder
timer Lektioner Undervisningsperioder
førsteUndervisningsdato Startdato (fra modulets første
undervisningsperiode)
sidsteUndervisningsdato Slutdato (for modulets sidste
undervisningsperiode)
Undervisningsperioder
Undervisningsperioder
holdBemærkning Bemærkning Hold, fanen 'Bemærkning'
afvikling Afvikling Undervisningsmoduler
skematimer Skema uden ringetid/Skema med ringetid
Skematime:
Property Felt (i LUDUS)
ugedag Ugedag
fraKl Fra kl. eller Lektion(er)
tilKl Til kl. eller Lektion(er)
lærere Lærer(e)
lokaler Lokale(r)
Lærer:
Property Felt (i LUDUS) Vindue
initialer Initialer Lærer, fanen 'Generelt'
fornavn Fornavn Lærer, fanen 'Generelt'
efternavn Efternavn Lærer, fanen 'Generelt'
titel Titel Lærer, fanen 'Generelt'
Ressourcer
Denne webservice stiller følgende ressourcer til rådighed:
Page 3 - last modified by Paw Dybdahl on 2012/02/28 09:45

LudusWeb - WebService_PubliseringAfKursuskatalog
HTTP URL Response
GET /restServices/catalog/total Det komplette kursuskatalog
GET /restServices/catalog/partial/{holdId}/
{holdStart}/{fagKode}
Page 4 - last modified by Paw Dybdahl on 2012/02/28 09:45
Et kursuskatalog, der kun indeholder
information om det angivne modul
GET /restServices/catalog/schema Formatet på kursuskataloget defineret som et
JSON-skema
URL'en til at hente oplysninger om modulet med holdid = da12, holdstart = 2011 og fagkode = 1234 bliver således:
https:///restServices/catalog/partial/da12/2011/1234
Format
{
"type" : "object",
"properties" : {
"undervisningModulList" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"holdId" : {
"type" : "string"
},
"holdStart" : {
"type" : "string"
},
"fagKode" : {
"type" : "string"
},
"holdNavn" : {
"type" : "string"
},
"holdTyper" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"maxAntalDeltagere" : {
"type" : "integer"
},
"antalDeltagere" : {
"type" : "integer"
},
"pris" : {
"type" : "number"
},
"alternativPris" : {
"type" : "number"
},
"antalTimerPrUge" : {
"type" : "number"
},
"timer" : {
"type" : "number"
},
"førsteUndervisningsdato" : {
"type" : "string",
"format" : "date",
"description" : "YYYY-MM-DD"
},
"sidsteUndervisningsdato" : {
"type" : "string",

LudusWeb - WebService_PubliseringAfKursuskatalog
"format" : "date",
"description" : "YYYY-MM-DD"
},
"holdBemærkning" : {
"type" : "string"
},
"afvikling" : {
"type" : "string"
},
"skematimer" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"ugedag" : {
"type" : "string",
"enum" : [ "MANDAG", "TIRSDAG", "ONSDAG", "TORSDAG", "FREDAG", "LØRDAG", "SØNDAG" ]
},
"fraKl" : {
"type" : "string",
"format" : "time",
"description" : "hh:mm:ss"
},
"tilKl" : {
"type" : "string",
"format" : "time",
"description" : "hh:mm:ss"
},
"lærere" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"initialer" : {
"type" : "string"
},
"fornavn" : {
"type" : "string"
},
"efternavn" : {
"type" : "string"
},
"titel" : {
"type" : "string"
}
}
}
},
"lokaler" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"undervisningsstedNavn" : {
"type" : "string"
},
"lokaleNummer" : {
"type" : "string"
}
}
}
}
}
}
Page 5 - last modified by Paw Dybdahl on 2012/02/28 09:45

}
}
}
}
}
}
LudusWeb - WebService_PubliseringAfKursuskatalog
Page 6 - last modified by Paw Dybdahl on 2012/02/28 09:45