ressourcen

Bereitgestellte Ressourcen

Dieser Service stellt Daten der Typen: Module und StudyCourse bereit. Diese können per REST Schnittstelle abgefragt werden. Hierbei wird der HAL Standart eingehalten.

Ressource: Module

Pfad: /modules/

{
      "id" : UUID,
      "name" : Name,
      "description" : Beschreibung,
      "projectType" : Type,
      "_links" : {
        "self" : {
          "href" : "https://api.prox.archi-lab.io/modules/UUID"
        },
        "module" : {
          "href" : "https://api.prox.archi-lab.io/modules/UUID"
        }
      }
    }

Beschreibung

"Module" sind Module, also alle Veranstaltungen, Pflichtveranstaltungen, oder weitere allgemein definierte Sachen, die Credit Points haben (Dies beinhaltet z.B. Fächer und Abschlussarbeiten). Ein Modul ist exakt einem Studiengang zugeordnet.

Felder	Type	Beschreibung	Constraints
id	UUID	Die ID des Elementes	Primary Key
name	Text	Der Name des Modules	Max Size: 255
description	Text	Beschreibung eines Moduls	Max Size: 9000
projectType	Enum	Projekt Type des Modules	-

Wertebereich für die Felder:

Feld	Werte
projectType	PP, BA, MA

Erklärung zu den Feldern:

Feld	Erklärung
-	-

Links:

Links	Beschreibung
self	Self Link der Ressource
module	Link, der auf diese Ressoruce zeigt

Link zu profile: "https://api.prox.archi-lab.io/profile/modules"
Link zu search: "https://api.prox.archi-lab.io/modules/search"

Search Links:

findByName_NameContainingIgnoreCase
https://api.prox.archi-lab.io/modules/search/findByName_NameContainingIgnoreCase{?name,page,size,sort}
Es werden alle Module zurück gegeben, welche den angegebenen Namen als Substring haben.

Ressource: StudyCourse

Pfad: /studyCourses/

{
      "id" : UUID,
      "name" : Name,
      "academicDegree" : Abschlussart (Bachelor / Master),
      "_links" : {
        "self" : {
          "href" : "https://api.prox.archi-lab.io/studyCourses/UUID"
        },
        "studyCourse" : {
          "href" : "https://api.prox.archi-lab.io/studyCourses/UUID"
        },
        "modules" : {
          "href" : "https://api.prox.archi-lab.io/studyCourses/UUID/modules"
        },
        "studyDirections" : {
          "href" : "https://api.prox.archi-lab.io/studyCourses/UUID/studyDirections"
        },
        "parentStudyCourse" : {
          "href" : "https://api.prox.archi-lab.io/studyCourses/UUID/parentStudyCourse"
        }
      }
    }

Beschreibung

"StudyCourses" sind Studiengänge, also Sachen, für die man sich bewerben kann bei der Hochschule, um diese zu Studieren und eingetragener Student zu werden.

Feld	Type	Beschreibung	Constraints
id	UUID	Die ID des Elementes	Primary Key
name	Text	Der Name des Studienganges	Max size: 255
academicDegree	Text	Die Abschlussart mit den Werten "Bachelor" und "Master"	-

Wertebereich für die Felder:

Feld	Werte
academicDegree	Bachelor, Master

Erklärung zu den Feldern:

Feld	Erklärung
-	-

Links:

Links	Beschreibung
self	Self Link der Ressource
studyCourse	Link, der auf diese Ressource zeigt
modules	Liste Module dieses Studienganges
studyDirections	Nicht Verwendet
parentStudyCourse	Nicht Verwendet

Link zu profile: "https://api.prox.archi-lab.io/profile/studyCourses"
Link zu search: "https://api.prox.archi-lab.io/studyCourses/search"

Search Links:

findByAcademicDegree
https://api.prox.archi-lab.io/studyCourses/search/findByAcademicDegree{?academicDegree}
Es werden alle StudyCourses zurück gegeben, welche den angegebenen Academic Degree haben.