import { BaseApi, type ApiFile } from '../api/BaseApi'; import { AbgangsartKatalog } from '../core/data/schule/AbgangsartKatalog'; import { Abiturdaten } from '../core/data/gost/Abiturdaten'; import { Abteilung } from '../core/data/schule/Abteilung'; import { AbteilungKlassenzuordnung } from '../core/data/schule/AbteilungKlassenzuordnung'; import { AllgemeineMerkmaleKatalogEintrag } from '../core/data/schule/AllgemeineMerkmaleKatalogEintrag'; import { Aufsichtsbereich } from '../core/data/schule/Aufsichtsbereich'; import { BenutzerAllgemeinCredentials } from '../core/data/benutzer/BenutzerAllgemeinCredentials'; import { BenutzerConfig } from '../core/data/benutzer/BenutzerConfig'; import { BenutzerDaten } from '../core/data/benutzer/BenutzerDaten'; import { BenutzerEMailDaten } from '../core/data/benutzer/BenutzerEMailDaten'; import { BenutzergruppeDaten } from '../core/data/benutzer/BenutzergruppeDaten'; import { BenutzergruppeListeEintrag } from '../core/data/benutzer/BenutzergruppeListeEintrag'; import { BenutzerKompetenzGruppenKatalogEintrag } from '../core/data/benutzer/BenutzerKompetenzGruppenKatalogEintrag'; import { BenutzerKompetenzKatalogEintrag } from '../core/data/benutzer/BenutzerKompetenzKatalogEintrag'; import { BenutzerLehrerCredentials } from '../core/data/benutzer/BenutzerLehrerCredentials'; import { BenutzerListeEintrag } from '../core/data/benutzer/BenutzerListeEintrag'; import { BerufskollegAnlageKatalogEintrag } from '../asd/data/schule/BerufskollegAnlageKatalogEintrag'; import { BerufskollegBerufsebeneKatalogEintrag } from '../core/data/schule/BerufskollegBerufsebeneKatalogEintrag'; import { BerufskollegFachklassenKatalog } from '../core/data/schule/BerufskollegFachklassenKatalog'; import { Beschaeftigungsart } from '../core/data/betrieb/Beschaeftigungsart'; import { BetriebAnsprechpartner } from '../core/data/betrieb/BetriebAnsprechpartner'; import { BetriebListeEintrag } from '../core/data/betrieb/BetriebListeEintrag'; import { BetriebStammdaten } from '../core/data/betrieb/BetriebStammdaten'; import { BilingualeSpracheKatalogEintrag } from '../asd/data/fach/BilingualeSpracheKatalogEintrag'; import { BKGymAbiturdaten } from '../core/abschluss/bk/d/BKGymAbiturdaten'; import { BKGymLeistungen } from '../core/data/bk/abi/BKGymLeistungen'; import { DatenbankVerbindungsdaten } from '../core/data/schema/DatenbankVerbindungsdaten'; import { DBSchemaListeEintrag } from '../core/data/db/DBSchemaListeEintrag'; import { EinschulungsartKatalogEintrag } from '../asd/data/schueler/EinschulungsartKatalogEintrag'; import { Einwilligungsart } from '../core/data/schule/Einwilligungsart'; import { ENMConfigResponse } from '../core/data/enm/ENMConfigResponse'; import { ENMDaten } from '../core/data/enm/ENMDaten'; import { ENMLehrerInitialKennwort } from '../core/data/enm/ENMLehrerInitialKennwort'; import { ENMLeistung } from '../core/data/enm/ENMLeistung'; import { ENMLeistungBemerkungen } from '../core/data/enm/ENMLeistungBemerkungen'; import { ENMLernabschnitt } from '../core/data/enm/ENMLernabschnitt'; import { ENMServerConfigElement } from '../core/data/enm/ENMServerConfigElement'; import { ENMTeilleistung } from '../core/data/enm/ENMTeilleistung'; import { Erzieherart } from '../core/data/erzieher/Erzieherart'; import { ErzieherListeEintrag } from '../core/data/erzieher/ErzieherListeEintrag'; import { ErzieherStammdaten } from '../core/data/erzieher/ErzieherStammdaten'; import { FachDaten } from '../core/data/fach/FachDaten'; import { FachgruppeKatalogEintrag } from '../asd/data/fach/FachgruppeKatalogEintrag'; import { FachKatalogEintrag } from '../asd/data/fach/FachKatalogEintrag'; import { Fahrschuelerart } from '../core/data/schule/Fahrschuelerart'; import { Floskel } from '../core/data/schule/Floskel'; import { Floskelgruppe } from '../core/data/schule/Floskelgruppe'; import { FoerderschwerpunktEintrag } from '../core/data/schule/FoerderschwerpunktEintrag'; import { FoerderschwerpunktKatalogEintrag } from '../asd/data/schule/FoerderschwerpunktKatalogEintrag'; import { GEAbschlussFaecher } from '../core/data/abschluss/GEAbschlussFaecher'; import { GostBelegpruefungErgebnis } from '../core/abschluss/gost/GostBelegpruefungErgebnis'; import { GostBelegpruefungsErgebnisse } from '../core/data/gost/GostBelegpruefungsErgebnisse'; import { GostBeratungslehrer } from '../core/data/gost/GostBeratungslehrer'; import { GostBlockungKurs } from '../core/data/gost/GostBlockungKurs'; import { GostBlockungKursAufteilung } from '../core/data/gost/GostBlockungKursAufteilung'; import { GostBlockungKursLehrer } from '../core/data/gost/GostBlockungKursLehrer'; import { GostBlockungListeneintrag } from '../core/data/gost/GostBlockungListeneintrag'; import { GostBlockungRegel } from '../core/data/gost/GostBlockungRegel'; import { GostBlockungRegelUpdate } from '../core/data/gost/GostBlockungRegelUpdate'; import { GostBlockungSchiene } from '../core/data/gost/GostBlockungSchiene'; import { GostBlockungsdaten } from '../core/data/gost/GostBlockungsdaten'; import { GostBlockungsergebnis } from '../core/data/gost/GostBlockungsergebnis'; import { GostBlockungsergebnisKursSchienenZuordnung } from '../core/data/gost/GostBlockungsergebnisKursSchienenZuordnung'; import { GostBlockungsergebnisKursSchuelerZuordnung } from '../core/data/gost/GostBlockungsergebnisKursSchuelerZuordnung'; import { GostBlockungsergebnisKursSchuelerZuordnungUpdate } from '../core/data/gost/GostBlockungsergebnisKursSchuelerZuordnungUpdate'; import { GostFach } from '../core/data/gost/GostFach'; import { GostJahrgang } from '../core/data/gost/GostJahrgang'; import { GostJahrgangFachkombination } from '../core/data/gost/GostJahrgangFachkombination'; import { GostJahrgangFachwahlen } from '../core/data/gost/GostJahrgangFachwahlen'; import { GostJahrgangFachwahlenHalbjahr } from '../core/data/gost/GostJahrgangFachwahlenHalbjahr'; import { GostJahrgangsdaten } from '../core/data/gost/GostJahrgangsdaten'; import { GostKlausurenCollectionAllData } from '../core/data/gost/klausurplanung/GostKlausurenCollectionAllData'; import { GostKlausurenCollectionData } from '../core/data/gost/klausurplanung/GostKlausurenCollectionData'; import { GostKlausurenCollectionHjData } from '../core/data/gost/klausurplanung/GostKlausurenCollectionHjData'; import { GostKlausurenCollectionSkrsKrsData } from '../core/data/gost/klausurplanung/GostKlausurenCollectionSkrsKrsData'; import { GostKlausurenUpdate } from '../core/data/gost/klausurplanung/GostKlausurenUpdate'; import { GostKlausurraum } from '../core/data/gost/klausurplanung/GostKlausurraum'; import { GostKlausurraumRich } from '../core/data/gost/klausurplanung/GostKlausurraumRich'; import { GostKlausurtermin } from '../core/data/gost/klausurplanung/GostKlausurtermin'; import { GostKlausurterminblockungDaten } from '../core/data/gost/klausurplanung/GostKlausurterminblockungDaten'; import { GostKlausurvorgabe } from '../core/data/gost/klausurplanung/GostKlausurvorgabe'; import { GostKursklausur } from '../core/data/gost/klausurplanung/GostKursklausur'; import { GostLaufbahnplanungBeratungsdaten } from '../core/data/gost/GostLaufbahnplanungBeratungsdaten'; import { GostLaufbahnplanungDaten } from '../core/data/gost/GostLaufbahnplanungDaten'; import { GostLeistungen } from '../core/data/gost/GostLeistungen'; import { GostNachschreibterminblockungKonfiguration } from '../core/data/gost/klausurplanung/GostNachschreibterminblockungKonfiguration'; import { GostSchuelerFachwahl } from '../core/data/gost/GostSchuelerFachwahl'; import { GostSchuelerklausur } from '../core/data/gost/klausurplanung/GostSchuelerklausur'; import { GostSchuelerklausurTermin } from '../core/data/gost/klausurplanung/GostSchuelerklausurTermin'; import { GostStatistikFachwahl } from '../core/data/gost/GostStatistikFachwahl'; import { Haltestelle } from '../core/data/schule/Haltestelle'; import { HerkunftKatalogEintrag } from '../core/data/schule/HerkunftKatalogEintrag'; import { HerkunftsartKatalogEintrag } from '../core/data/schule/HerkunftsartKatalogEintrag'; import { HerkunftsschulnummerKatalogEintrag } from '../core/data/schule/HerkunftsschulnummerKatalogEintrag'; import { JahrgaengeKatalogEintrag } from '../asd/data/jahrgang/JahrgaengeKatalogEintrag'; import { JahrgangsDaten } from '../core/data/jahrgang/JahrgangsDaten'; import { KAOAAnschlussoptionenKatalogEintrag } from '../asd/data/kaoa/KAOAAnschlussoptionenKatalogEintrag'; import { KAOABerufsfeldKatalogEintrag } from '../asd/data/kaoa/KAOABerufsfeldKatalogEintrag'; import { KAOAEbene4KatalogEintrag } from '../asd/data/kaoa/KAOAEbene4KatalogEintrag'; import { KAOAKategorieKatalogEintrag } from '../asd/data/kaoa/KAOAKategorieKatalogEintrag'; import { KAOAMerkmalKatalogEintrag } from '../asd/data/kaoa/KAOAMerkmalKatalogEintrag'; import { KAOAZusatzmerkmalKatalogEintrag } from '../asd/data/kaoa/KAOAZusatzmerkmalKatalogEintrag'; import { KatalogEintrag } from '../core/data/kataloge/KatalogEintrag'; import { KatalogEintragOrte } from '../core/data/kataloge/KatalogEintragOrte'; import { KatalogEintragOrtsteile } from '../core/data/kataloge/KatalogEintragOrtsteile'; import { KatalogEintragStrassen } from '../core/data/kataloge/KatalogEintragStrassen'; import { KatalogEntlassgrund } from '../core/data/kataloge/KatalogEntlassgrund'; import { Kindergarten } from '../core/data/schule/Kindergarten'; import { KindergartenbesuchKatalogEintrag } from '../asd/data/schule/KindergartenbesuchKatalogEintrag'; import { KlassenartKatalogEintrag } from '../asd/data/klassen/KlassenartKatalogEintrag'; import { KlassenDaten } from '../asd/data/klassen/KlassenDaten'; import { KursDaten } from '../asd/data/kurse/KursDaten'; import { KursLehrer } from '../asd/data/kurse/KursLehrer'; import { LehrerAbgangsgrundKatalogEintrag } from '../asd/data/lehrer/LehrerAbgangsgrundKatalogEintrag'; import { LehrerAnrechnungsgrundKatalogEintrag } from '../asd/data/lehrer/LehrerAnrechnungsgrundKatalogEintrag'; import { LehrerBeschaeftigungsartKatalogEintrag } from '../asd/data/lehrer/LehrerBeschaeftigungsartKatalogEintrag'; import { LehrerEinsatzstatusKatalogEintrag } from '../asd/data/lehrer/LehrerEinsatzstatusKatalogEintrag'; import { LehrerEinwilligung } from '../core/data/lehrer/LehrerEinwilligung'; import { LehrerFachrichtungAnerkennungKatalogEintrag } from '../asd/data/lehrer/LehrerFachrichtungAnerkennungKatalogEintrag'; import { LehrerFachrichtungEintrag } from '../asd/data/lehrer/LehrerFachrichtungEintrag'; import { LehrerFachrichtungKatalogEintrag } from '../asd/data/lehrer/LehrerFachrichtungKatalogEintrag'; import { LehrerLehramtAnerkennungKatalogEintrag } from '../asd/data/lehrer/LehrerLehramtAnerkennungKatalogEintrag'; import { LehrerLehramtEintrag } from '../asd/data/lehrer/LehrerLehramtEintrag'; import { LehrerLehramtKatalogEintrag } from '../asd/data/lehrer/LehrerLehramtKatalogEintrag'; import { LehrerLehrbefaehigungAnerkennungKatalogEintrag } from '../asd/data/lehrer/LehrerLehrbefaehigungAnerkennungKatalogEintrag'; import { LehrerLehrbefaehigungEintrag } from '../asd/data/lehrer/LehrerLehrbefaehigungEintrag'; import { LehrerLehrbefaehigungKatalogEintrag } from '../asd/data/lehrer/LehrerLehrbefaehigungKatalogEintrag'; import { LehrerLeitungsfunktionKatalogEintrag } from '../asd/data/lehrer/LehrerLeitungsfunktionKatalogEintrag'; import { LehrerLernplattform } from '../core/data/lehrer/LehrerLernplattform'; import { LehrerListeEintrag } from '../core/data/lehrer/LehrerListeEintrag'; import { LehrerMehrleistungsartKatalogEintrag } from '../asd/data/lehrer/LehrerMehrleistungsartKatalogEintrag'; import { LehrerMinderleistungsartKatalogEintrag } from '../asd/data/lehrer/LehrerMinderleistungsartKatalogEintrag'; import { LehrerPersonalabschnittsdaten } from '../asd/data/lehrer/LehrerPersonalabschnittsdaten'; import { LehrerPersonalabschnittsdatenAnrechnungsstunden } from '../asd/data/lehrer/LehrerPersonalabschnittsdatenAnrechnungsstunden'; import { LehrerPersonalabschnittsdatenLehrerfunktion } from '../asd/data/lehrer/LehrerPersonalabschnittsdatenLehrerfunktion'; import { LehrerPersonaldaten } from '../asd/data/lehrer/LehrerPersonaldaten'; import { LehrerRechtsverhaeltnisKatalogEintrag } from '../asd/data/lehrer/LehrerRechtsverhaeltnisKatalogEintrag'; import { LehrerStammdaten } from '../asd/data/lehrer/LehrerStammdaten'; import { LehrerZugangsgrundKatalogEintrag } from '../asd/data/lehrer/LehrerZugangsgrundKatalogEintrag'; import { Lernplattform } from '../core/data/schule/Lernplattform'; import { List } from '../java/util/List'; import { LongAndStringLists } from '../core/data/LongAndStringLists'; import { Merkmal } from '../core/data/schule/Merkmal'; import { NationalitaetenKatalogEintrag } from '../asd/data/schule/NationalitaetenKatalogEintrag'; import { NoteKatalogEintrag } from '../asd/data/NoteKatalogEintrag'; import { OAuth2ClientConnection } from '../core/data/oauth2/OAuth2ClientConnection'; import { OrganisationsformKatalogEintrag } from '../asd/data/schule/OrganisationsformKatalogEintrag'; import { OrtKatalogEintrag } from '../core/data/kataloge/OrtKatalogEintrag'; import { OrtsteilKatalogEintrag } from '../core/data/kataloge/OrtsteilKatalogEintrag'; import { PruefungsordnungKatalogEintrag } from '../core/data/schule/PruefungsordnungKatalogEintrag'; import { Raum } from '../core/data/schule/Raum'; import { ReformpaedagogikKatalogEintrag } from '../core/data/schule/ReformpaedagogikKatalogEintrag'; import { ReligionEintrag } from '../core/data/schule/ReligionEintrag'; import { ReligionKatalogEintrag } from '../asd/data/schule/ReligionKatalogEintrag'; import { ReportingParameter } from '../core/data/reporting/ReportingParameter'; import { Schild3KatalogEintragAbiturInfos } from '../core/data/schild3/Schild3KatalogEintragAbiturInfos'; import { Schild3KatalogEintragDatenart } from '../core/data/schild3/Schild3KatalogEintragDatenart'; import { Schild3KatalogEintragDQRNiveaus } from '../core/data/schild3/Schild3KatalogEintragDQRNiveaus'; import { Schild3KatalogEintragExportCSV } from '../core/data/schild3/Schild3KatalogEintragExportCSV'; import { Schild3KatalogEintragFilterFehlendeEintraege } from '../core/data/schild3/Schild3KatalogEintragFilterFehlendeEintraege'; import { Schild3KatalogEintragLaender } from '../core/data/schild3/Schild3KatalogEintragLaender'; import { Schild3KatalogEintragPruefungsordnung } from '../core/data/schild3/Schild3KatalogEintragPruefungsordnung'; import { Schild3KatalogEintragPruefungsordnungOption } from '../core/data/schild3/Schild3KatalogEintragPruefungsordnungOption'; import { Schild3KatalogEintragUnicodeUmwandlung } from '../core/data/schild3/Schild3KatalogEintragUnicodeUmwandlung'; import { Schild3KatalogEintragVersetzungsvermerke } from '../core/data/schild3/Schild3KatalogEintragVersetzungsvermerke'; import { SchuelerBetriebsdaten } from '../asd/data/schueler/SchuelerBetriebsdaten'; import { SchuelerEinwilligung } from '../core/data/schueler/SchuelerEinwilligung'; import { SchuelerEinwilligungsartenZusammenfassung } from '../core/data/schueler/SchuelerEinwilligungsartenZusammenfassung'; import { SchuelerKAoADaten } from '../core/data/schueler/SchuelerKAoADaten'; import { SchuelerLeistungsdaten } from '../asd/data/schueler/SchuelerLeistungsdaten'; import { SchuelerLernabschnittBemerkungen } from '../asd/data/schueler/SchuelerLernabschnittBemerkungen'; import { SchuelerLernabschnittListeEintrag } from '../core/data/schueler/SchuelerLernabschnittListeEintrag'; import { SchuelerLernabschnittsdaten } from '../asd/data/schueler/SchuelerLernabschnittsdaten'; import { SchuelerLernplattform } from '../core/data/schueler/SchuelerLernplattform'; import { SchuelerListeEintrag } from '../core/data/schueler/SchuelerListeEintrag'; import { SchuelerSchulbesuchMerkmal } from '../asd/data/schueler/SchuelerSchulbesuchMerkmal'; import { SchuelerSchulbesuchSchule } from '../asd/data/schueler/SchuelerSchulbesuchSchule'; import { SchuelerSchulbesuchsdaten } from '../asd/data/schueler/SchuelerSchulbesuchsdaten'; import { SchuelerStammdaten } from '../asd/data/schueler/SchuelerStammdaten'; import { SchuelerStammdatenNeu } from '../asd/data/schueler/SchuelerStammdatenNeu'; import { SchuelerStatusKatalogEintrag } from '../asd/data/schueler/SchuelerStatusKatalogEintrag'; import { SchuelerTelefon } from '../core/data/schueler/SchuelerTelefon'; import { SchuelerVermerkartZusammenfassung } from '../core/data/schueler/SchuelerVermerkartZusammenfassung'; import { SchuelerVermerke } from '../core/data/schueler/SchuelerVermerke'; import { SchulabschlussAllgemeinbildendKatalogEintrag } from '../asd/data/schule/SchulabschlussAllgemeinbildendKatalogEintrag'; import { SchulabschlussBerufsbildendKatalogEintrag } from '../asd/data/schule/SchulabschlussBerufsbildendKatalogEintrag'; import { SchulEintrag } from '../core/data/kataloge/SchulEintrag'; import { SchulenKatalogEintrag } from '../core/data/schule/SchulenKatalogEintrag'; import { SchuleStammdaten } from '../asd/data/schule/SchuleStammdaten'; import { SchulformKatalogEintrag } from '../asd/data/schule/SchulformKatalogEintrag'; import { SchulgliederungKatalogEintrag } from '../asd/data/schule/SchulgliederungKatalogEintrag'; import { Schulleitung } from '../asd/data/schule/Schulleitung'; import { SchultraegerKatalogEintrag } from '../core/data/schule/SchultraegerKatalogEintrag'; import { SimpleOperationResponse } from '../core/data/SimpleOperationResponse'; import { SMTPServerKonfiguration } from '../core/data/email/SMTPServerKonfiguration'; import { Sportbefreiung } from '../core/data/schule/Sportbefreiung'; import { Sprachbelegung } from '../asd/data/schueler/Sprachbelegung'; import { Sprachpruefung } from '../asd/data/schueler/Sprachpruefung'; import { SprachpruefungsniveauKatalogEintrag } from '../core/data/fach/SprachpruefungsniveauKatalogEintrag'; import { SprachreferenzniveauKatalogEintrag } from '../asd/data/fach/SprachreferenzniveauKatalogEintrag'; import { Stundenplan } from '../core/data/stundenplan/Stundenplan'; import { StundenplanAufsichtsbereich } from '../core/data/stundenplan/StundenplanAufsichtsbereich'; import { StundenplanKalenderwochenzuordnung } from '../core/data/stundenplan/StundenplanKalenderwochenzuordnung'; import { StundenplanKomplett } from '../core/data/stundenplan/StundenplanKomplett'; import { StundenplanLehrer } from '../core/data/stundenplan/StundenplanLehrer'; import { StundenplanListeEintrag } from '../core/data/stundenplan/StundenplanListeEintrag'; import { StundenplanPausenaufsicht } from '../core/data/stundenplan/StundenplanPausenaufsicht'; import { StundenplanPausenaufsichtBereich } from '../core/data/stundenplan/StundenplanPausenaufsichtBereich'; import { StundenplanPausenaufsichtBereichUpdate } from '../core/data/stundenplan/StundenplanPausenaufsichtBereichUpdate'; import { StundenplanPausenzeit } from '../core/data/stundenplan/StundenplanPausenzeit'; import { StundenplanRaum } from '../core/data/stundenplan/StundenplanRaum'; import { StundenplanSchiene } from '../core/data/stundenplan/StundenplanSchiene'; import { StundenplanUnterricht } from '../core/data/stundenplan/StundenplanUnterricht'; import { StundenplanUnterrichtsverteilung } from '../core/data/stundenplan/StundenplanUnterrichtsverteilung'; import { StundenplanZeitraster } from '../core/data/stundenplan/StundenplanZeitraster'; import { TelefonArt } from '../core/data/schule/TelefonArt'; import { UebergangsempfehlungKatalogEintrag } from '../asd/data/schueler/UebergangsempfehlungKatalogEintrag'; import { VerkehrsspracheKatalogEintrag } from '../asd/data/schule/VerkehrsspracheKatalogEintrag'; import { VermerkartEintrag } from '../core/data/schule/VermerkartEintrag'; import { WiedervorlageEintrag } from '../core/data/schule/WiedervorlageEintrag'; import { ZulaessigeKursartKatalogEintrag } from '../asd/data/kurse/ZulaessigeKursartKatalogEintrag'; export declare class ApiServer extends BaseApi { /** * * Erstellt eine neue API mit der übergebenen Konfiguration. * * @param {string} url - die URL des Servers: Alle Pfadangaben sind relativ zu dieser URL * @param {string} username - der Benutzername für den API-Zugriff * @param {string} password - das Kennwort des Benutzers für den API-Zugriff */ constructor(url: string, username: string, password: string); /** * Implementierung der GET-Methode getConfigCertificate für den Zugriff auf die URL https://{hostname}/config/certificate * * Gibt das Zertifikat des Server zurück. * * Mögliche HTTP-Antworten: * Code 200: Das Zertifikat des Servers * - Mime-Type: text/plain * - Rückgabe-Typ: String * Code 500: Das Zertifikat wurde nicht gefunden * * @returns Das Zertifikat des Servers */ getConfigCertificate(): Promise; /** * Implementierung der GET-Methode getConfigCertificateBase64 für den Zugriff auf die URL https://{hostname}/config/certificate_base64 * * Gibt das Zertifikat des Server in Base64-Kodierung zurück. * * Mögliche HTTP-Antworten: * Code 200: Das Base-64-kodierte Zertifikat des Servers * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 500: Das Zertifikat wurde nicht gefunden * * @returns Das Base-64-kodierte Zertifikat des Servers */ getConfigCertificateBase64(): Promise; /** * Implementierung der GET-Methode getConfigCertificateFile für den Zugriff auf die URL https://{hostname}/config/certificate_file * * Gibt die Zertifikatsdatei des Server zurück. * * Mögliche HTTP-Antworten: * Code 200: Die Zertifikatsdatei des Servers * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Das Zertifikat wurde nicht gefunden * Code 500: Es konnte nicht auf das Zertifikat zugegriffen werden * * @returns Die Zertifikatsdatei des Servers */ getConfigCertificateFile(): Promise; /** * Implementierung der GET-Methode getConfigDBSchemata für den Zugriff auf die URL https://{hostname}/config/db/schemata * * Gibt eine sortierte Übersicht von allen konfigurierten DB-Schemata zurück. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von DB-Schema-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * * @returns Eine Liste von DB-Schema-Listen-Einträgen */ getConfigDBSchemata(): Promise>; /** * Implementierung der GET-Methode getConfigPublicKeyBase64 für den Zugriff auf die URL https://{hostname}/config/publickey_base64 * * Gibt den öffentlichen Schlüssel des Server in Base64-Kodierung zurück. * * Mögliche HTTP-Antworten: * Code 200: Der Base-64-kodierte, öffentliche Schlüssel des Servers * - Mime-Type: text/plain * - Rückgabe-Typ: String * Code 500: Der öffentliche Schlüssel wurde nicht gefunden * * @returns Der Base-64-kodierte, öffentliche Schlüssel des Servers */ getConfigPublicKeyBase64(): Promise; /** * Implementierung der PATCH-Methode patchKatalogFoerderschwerpunkt für den Zugriff auf die URL https://{hostname}/db/{schema}/{id : \d+}/foerderschwerpunkte * * Passt den Förderschwerpunkt zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Förderschwerpunkten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Förderschwerpunkte zu ändern. * Code 404: Kein Förderschwerpunkt mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchKatalogFoerderschwerpunkt(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogOrte für den Zugriff auf die URL https://{hostname}/db/{schema}/allgemein/orte * * Erstellt eine Liste aller in dem Katalog vorhandenen Orte. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Orts-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Orts-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Orts-Katalog-Einträgen */ getKatalogOrte(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogOrtsteile für den Zugriff auf die URL https://{hostname}/db/{schema}/allgemein/ortsteile * * Erstellt eine Liste aller in dem Katalog vorhandenen Ortsteile. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Ortsteil-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Ortsteil-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Ortsteil-Katalog-Einträgen */ getKatalogOrtsteile(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogStrassen für den Zugriff auf die URL https://{hostname}/db/{schema}/allgemein/strassen * * Erstellt eine Liste aller in dem Katalog vorhandenen Strassen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Straßen-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Straßen-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Straßen-Katalog-Einträgen */ getKatalogStrassen(schema: string): Promise>; /** * Implementierung der GET-Methode getBenutzerliste für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/ * * Erstellt eine Liste aller Benutzer.Es wird geprüft, ob der SVWS-Benutzer die notwendige Administrator-Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Benutzer-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Benutzerdaten anzusehen. * Code 404: Keine Benutzer-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Benutzer-Einträgen */ getBenutzerliste(schema: string): Promise>; /** * Implementierung der GET-Methode getBenutzerDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+} * * Liest die Daten des Benutzers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Benutzerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Benutzers * - Mime-Type: application/json * - Rückgabe-Typ: BenutzerDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzerdaten anzusehen. * Code 404: Kein Benutzer-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Benutzers */ getBenutzerDaten(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addBenutzerAdmin für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/addAdmin * * Setzt Admin-Berechtigung für den Benutzer.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Information wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Benutzer als administrativer Benutzer zu setzen * Code 404: Der Benutzer ist nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ addBenutzerAdmin(schema: string, id: number): Promise; /** * Implementierung der POST-Methode setBenutzername für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/anmeldename * * Setzt den Anmeldenamen eines Benutzers.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Setzen des Anmeldenamenss besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Anmeldename wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um das Kennwort zu setzen. * Code 404: Der Anmeldename zu dem Benutzer sind nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ setBenutzername(data: string | null, schema: string, id: number): Promise; /** * Implementierung der POST-Methode setAnzeigename für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/anzeigename * * Setzt den Anzeigenamen eines Benutzers.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Setzen des Anzeigenamens besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Anzeigename wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Anzeigenamen zu setzen. * Code 404: Der Anzeigename zu dem Benutzer sind nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ setAnzeigename(data: string | null, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addBenutzerKompetenzen für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/kompetenz/add * * Fügt Kompetenzen bei einem Benutzer hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Setzen der Kompetenzen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Kompetenzen wurden erfolgreich hinzugefügt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kompetenzen zu hinzuzufügen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ addBenutzerKompetenzen(data: List, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode removeBenutzerKompetenzen für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/kompetenz/remove * * Entfernt Kompetenzen bei einem Benutzer.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen der Kompetenzen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Kompetenzen wurden erfolgreich entfernt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kompetenzen zu entfernen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ removeBenutzerKompetenzen(data: List, schema: string, id: number): Promise; /** * Implementierung der POST-Methode setPassword für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/password * * Setzt das neue Passwort eines Benutzers.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Setzen des Kennwortes besitzt. * * Mögliche HTTP-Antworten: * Code 204: Das Passwort wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um das Kennwort zu setzen. * Code 404: Das Passwort zu dem Benutzer sind nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ setPassword(data: string | null, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode removeBenutzerAdmin für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/{id : \d+}/removeAdmin * * Entfernt die Admin-Berechtigung des Benutzers mit der id.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen der Admin-Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 204: Die Admin-Berechtigung wurde erfolgreich entfernt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Admin-Berechtigung zu entfernen. * Code 404: Der Benutzer ist nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ removeBenutzerAdmin(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogBenutzerkompetenzen für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/allgemein/kompetenzen * * Liefert den Katalog der Benutzerkompetenzen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Kataloge besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Benutzerkompetenzen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Benutzerkompetenzen */ getKatalogBenutzerkompetenzen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogBenutzerkompetenzgruppen für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/allgemein/kompetenzgruppen * * Liefert den Katalog der Benutzerkompetenzgruppen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Kataloge besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Benutzerkompetenzgruppen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Benutzerkompetenzgruppen */ getKatalogBenutzerkompetenzgruppen(schema: string): Promise>; /** * Implementierung der GET-Methode getBenutzerDatenEigene für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/angemeldet/daten * * Liefert zu dem angemeldeten Benutzer, der diese Abfrage ausführt, die zugehörigen Daten. Dabei wird geprüft, ob der SVWS-Benutzer angemeldet ist. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Benutzers * - Mime-Type: application/json * - Rückgabe-Typ: BenutzerDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzerdaten anzusehen. * Code 404: Kein Benutzer-Eintrag gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Benutzers */ getBenutzerDatenEigene(schema: string): Promise; /** * Implementierung der GET-Methode getBenutzerEmailDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/angemeldet/daten/email * * Liefert zu dem angemeldeten Benutzer, der diese Abfrage ausführt, die zugehörigen EMail-Daten. Dabei wird geprüft, ob der SVWS-Benutzer angemeldet ist. * * Mögliche HTTP-Antworten: * Code 200: Die EMail-Daten des Benutzers * - Mime-Type: application/json * - Rückgabe-Typ: BenutzerEMailDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzerdaten anzusehen. * Code 404: Kein Benutzer-Eintrag gefunden * Code 500: Ein interner Fehler ist aus dem Server aufgetreten * * @param {string} schema - der Pfad-Parameter schema * * @returns Die EMail-Daten des Benutzers */ getBenutzerEmailDaten(schema: string): Promise; /** * Implementierung der PATCH-Methode patchBenutzerEmailDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/angemeldet/daten/email * * Passt die EMail-Daten des angemeldeten Benutzers an. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchBenutzerEmailDaten(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode createBenutzergruppe für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/benutzergruppe/new * * Erstellt eine neue Benutzergruppe und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Benutzergruppe besitzt. * * Mögliche HTTP-Antworten: * Code 200: Benutzergruppe wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: BenutzergruppeDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Benutzer anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {BenutzergruppeDaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Benutzergruppe wurde erfolgreich angelegt. */ createBenutzergruppe(data: BenutzergruppeDaten, schema: string): Promise; /** * Implementierung der GET-Methode getBenutzergruppenliste für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe * * Erstellt eine Liste aller Benutzergruppen.Es wird geprüft, ob der SVWS-Benutzer die notwendige Administrator-Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Benutzergruppen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Benutzergruppendaten anzusehen. * Code 404: Keine Benutzergruppen-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Benutzergruppen-Einträgen */ getBenutzergruppenliste(schema: string): Promise>; /** * Implementierung der GET-Methode getBenutzergruppeDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+} * * Liest die Daten der Benutzergruppe zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Benutzergruppendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Benutzergruppe * - Mime-Type: application/json * - Rückgabe-Typ: BenutzergruppeDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzergruppendaten anzusehen. * Code 404: Kein Benutzergruppen-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Benutzergruppe */ getBenutzergruppeDaten(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addBenutzergruppeAdmin für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/addAdmin * * Setzt ob die Benutzergruppe eine administrative Benutzergruppe ist oder nicht.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Information wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Gruppe als administrative Gruppe zu setzen * Code 404: Die Benutzergruppe ist nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ addBenutzergruppeAdmin(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getBenutzerMitGruppenID für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/benutzer * * Liest die Benutzer der Benutzergruppe zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Benutzergruppendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Benutzer der Benutzergruppe * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzergruppendaten anzusehen. * Code 404: Kein Benutzergruppen-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Benutzer der Benutzergruppe */ getBenutzerMitGruppenID(schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addBenutzergruppeBenutzer für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/benutzer/add * * Fügt Benutzer bei einer Benutzergruppe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen der Benutzer besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Benutzer wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: BenutzergruppeDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um neue Benutzer hinzuzufügen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Benutzer wurden erfolgreich hinzugefügt. */ addBenutzergruppeBenutzer(data: List, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode removeBenutzergruppeBenutzer für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/benutzer/remove * * Entfernt Benutzer bei einer Benutzergruppe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen der Benutzer besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Benutzer wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: BenutzergruppeDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um neue Benutzer zu entfernen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Benutzer wurden erfolgreich hinzugefügt. */ removeBenutzergruppeBenutzer(data: List, schema: string, id: number): Promise; /** * Implementierung der POST-Methode setBenutzergruppeBezeichnung für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/bezeichnung * * Setzt die Bezeichnung der Benutzergruppe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Information wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Bezeichnung der Gruppe zu setzen * Code 404: Die Benutzergruppe ist nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ setBenutzergruppeBezeichnung(data: string | null, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addBenutzergruppeKompetenzen für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/kompetenz/add * * Fügt Kompetenzen bei einer Benutzergruppe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Setzen der Kompetenzen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Kompetenzen wurden erfolgreich hinzugefügt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kompetenzen zu hinzuzufügen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ addBenutzergruppeKompetenzen(data: List, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode removeBenutzergruppeKompetenzen für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/kompetenz/remove * * Entfernt Kompetenzen bei einer Benutzergruppe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entferen der Kompetenzen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Kompetenzen wurden erfolgreich hinzugefügt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kompetenzen zu entfernen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ removeBenutzergruppeKompetenzen(data: List, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode removeBenutzergruppeAdmin für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/gruppe/{id : \d+}/removeAdmin * * Entfernt die Admin-Berechtigung er Benutzergruppe mit der idDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen der Admin-Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 204: Die Information wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Admin-Berechtigung zu entfernen. * Code 404: Die Benutzergruppe ist nicht vorhanden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ removeBenutzergruppeAdmin(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode removeBenutzerGruppe für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/guppe/remove * * Löscht eine oder mehrere Benutzergruppe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Benutzergruppen wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzergruppen zu löschen. * Code 404: Benötigte Information zur Benutzergruppe wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ removeBenutzerGruppe(data: List, schema: string): Promise; /** * Implementierung der POST-Methode createBenutzerAllgemein für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/new * * Erstellt einen neuen Benutzer und gibt ihn zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Benutzers besitzt. * * Mögliche HTTP-Antworten: * Code 200: Benutzer wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: BenutzerDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Benutzer anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {BenutzerAllgemeinCredentials} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Benutzer wurde erfolgreich angelegt. */ createBenutzerAllgemein(data: BenutzerAllgemeinCredentials, schema: string): Promise; /** * Implementierung der POST-Methode createBenutzerLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/new/lehrer * * Erstellt einen neuen Lehrer-Benutzer und gibt ihn zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Benutzers besitzt. * * Mögliche HTTP-Antworten: * Code 200: Benutzer wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: BenutzerDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Benutzer anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {BenutzerLehrerCredentials} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Benutzer wurde erfolgreich angelegt. */ createBenutzerLehrer(data: BenutzerLehrerCredentials, schema: string): Promise; /** * Implementierung der DELETE-Methode removeBenutzerMenge für den Zugriff auf die URL https://{hostname}/db/{schema}/benutzer/remove * * Löscht einen oder mehrere Benutzer.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Benutzer wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Benutzer zu löschen. * Code 404: Benötigte Information zum Benutzer wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ removeBenutzerMenge(data: List, schema: string): Promise; /** * Implementierung der GET-Methode getBetriebe für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/ * * Erstellt eine Liste aller in der Datenbank vorhandenen Betriebe unter Angabe der ID, der Betriebsart , des Betriebnamens, Kontaktdaten, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Betriebsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Betrieb-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebdaten anzusehen. * Code 404: Keine Betrieb-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Betrieb-Listen-Einträgen */ getBetriebe(schema: string): Promise>; /** * Implementierung der POST-Methode createBetriebansprechpartner für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{betrieb_id : \d+}/ansprechpartner/new * * Erstellt einen neuen Betriebansprechpartner und gibt die dazugehörige ID zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Betriebansprechpartners besitzt. * * Mögliche HTTP-Antworten: * Code 200: Ansprechpartner wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: BetriebAnsprechpartner * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Ansprechpartner anzulegen. * Code 404: Kein Betrieb mit der angegebenen ID gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {BetriebAnsprechpartner} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} betrieb_id - der Pfad-Parameter betrieb_id * * @returns Ansprechpartner wurde erfolgreich angelegt. */ createBetriebansprechpartner(data: BetriebAnsprechpartner, schema: string, betrieb_id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerBetriebsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}/betrieb * * Passt die Schüler-Betriebsdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerbetreibsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Schüler-Betriebsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten zu ändern. * Code 404: Kein Schülerbetrieb-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuelerBetriebsdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchuelerBetriebsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}/betrieb * * Liest die Daten des Schülerbetriebs zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen vom Schülerbetrieb besitzt. * * Mögliche HTTP-Antworten: * Code 200: Stammdaten des Schülerbetriebs. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerBetriebsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerbetreibe anzusehen. * Code 404: Kein Schülerbetrieb gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Stammdaten des Schülerbetriebs. */ getSchuelerBetriebsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getBetriebAnsprechpartnerdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}/betriebansprechpartner * * Liest die Daten des Betriebanpsrechpartners zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen vom Betriebanpsrechpartner besitzt. * * Mögliche HTTP-Antworten: * Code 200: Stammdaten des Betriebanpsrechpartners. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebanpsrechpartner anzusehen. * Code 404: Kein Betriebanpsrechpartner gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Stammdaten des Betriebanpsrechpartners. */ getBetriebAnsprechpartnerdaten(schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchBetriebanpsrechpartnerdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}/betriebansprechpartner * * Passt die Betriebanpsrechpartner-Daten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern vom Betriebanpsrechpartner besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Betriebanpsrechpartner-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebanpsrechpartner-Datenn zu ändern. * Code 404: Kein Betriebanpsrechpartner-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchBetriebanpsrechpartnerdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getBetriebStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}/stammdaten * * Liest die Stammdaten des Betriebs zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten eines Betriebs * - Mime-Type: application/json * - Rückgabe-Typ: BetriebStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebsdaten anzusehen. * Code 404: Kein Betrieb-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Stammdaten eines Betriebs */ getBetriebStammdaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchBetriebStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}/stammdaten * * Passt die Betrieb-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Erzieherdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Betrieb-Stammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebdaten zu ändern. * Code 404: Kein Betrieb-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchBetriebStammdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getBetriebAnsprechpartner für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/{id : \d+}betriebansprechpartnerliste * * Erstellt eine Liste aller in der Datenbank vorhandenen Betriebansprechpartner , des Ansprechpartnername, Kontaktdaten, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Betriebsansprechpartnern besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Betriebansprechpartnern * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebdaten anzusehen. * Code 404: Keine Betrieb-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Eine Liste von Betriebansprechpartnern */ getBetriebAnsprechpartner(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getBeschaeftigungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/beschaeftigungsarten * * Gibt die Beschäftigungsarten zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Beschäftigungsarten. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Beschäftigungsarten. */ getBeschaeftigungsarten(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchBeschaeftigungsart für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/beschaeftigungsarten/{id : \d+} * * Patched die Beschäftigungsart mit der angegebenen ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Beschäftigungsart-Daten zu ändern. * Code 404: Keine Beschäftigungsart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchBeschaeftigungsart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addBeschaeftigungsart für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/beschaeftigungsarten/create * * Erstellt eine neue Beschäftigungsart, insofern die notwendigen Berechtigungen vorliegen.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Beschäftigungsart besitzt. * * Mögliche HTTP-Antworten: * Code 201: Beschäftigungsart wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Beschaeftigungsart * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Beschäftigungsart anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Beschäftigungsart wurde erfolgreich hinzugefügt. */ addBeschaeftigungsart(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteBeschaeftigungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/beschaeftigungsarten/delete/multiple * * Entfernt mehrere Beschäftigungsarten, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Beschäftigungsarten zu entfernen. * Code 404: Beschäftigungsarten nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteBeschaeftigungsarten(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getBetriebeAnsprechpartner für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/betriebansprechpartner * * Erstellt eine Liste aller in der Datenbank vorhandenen Betriebansprechpartner, des Ansprechpartnername, Kontaktdaten, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Betriebsansprechpartnern besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Betriebansprechpartnern * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebdaten anzusehen. * Code 404: Keine Betrieb-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Betriebansprechpartnern */ getBetriebeAnsprechpartner(schema: string): Promise>; /** * Implementierung der DELETE-Methode removeBetriebansprechpartner für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/betriebansprechpartner/remove * * Löscht einen oder mehrere Betriebsansprechpartner.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Betriebsansprechpartner wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Betriebsansprechpartner zu löschen. * Code 404: Benötigte Information zum Betriebsansprechpartner wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ removeBetriebansprechpartner(data: List, schema: string): Promise; /** * Implementierung der GET-Methode getKatalogBetriebsart für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/betriebsart * * Erstellt eine Liste aller in dem Katalog vorhandenen Betriebsarten unter Angabe der ID, eines Kürzels und der textuellen Beschreibung sowie der Information, ob der Eintrag in der Anwendung sichtbar bzw. änderbar sein soll, und gibt diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen zu den Betriebsarten. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen zu den Betriebsarten. */ getKatalogBetriebsart(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogBetriebsartMitID für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/betriebsart/{id : \d+} * * Liest die Daten der Betriebsart zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Betriebsarten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Katalog-Eintrag zu den Betriebsarten. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Katalog-Eintrag zu den Betriebsarten. */ getKatalogBetriebsartMitID(schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchBetriebsart für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/betriebsart/{id : \d+} * * Passt die Beschäftigungsart-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Betriebssart besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Beschäftigungsart-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Beschäftigungsart-Daten zu ändern. * Code 404: Keine Beschäftigungsart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchBetriebsart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode createBetriebsart für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/betriebsart/new * * Erstellt eine neue Betriebart und gibt den neuen Datensatz zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eine Betriebsart besitzt. * * Mögliche HTTP-Antworten: * Code 200: Betiebsart wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: KatalogEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Betriebsart anzulegen. * Code 404: Kein Betrieb mit der angegebenen ID gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {KatalogEintrag} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Betiebsart wurde erfolgreich angelegt. */ createBetriebsart(data: KatalogEintrag, schema: string): Promise; /** * Implementierung der POST-Methode createBetrieb für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/new * * Erstellt einen neuen Betrieb und gibt den neuen Datensatz zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Betriebes besitzt. * * Mögliche HTTP-Antworten: * Code 200: Betieb wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: BetriebStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Betrieb anzulegen. * Code 404: Keine Betriebart oder kein Ort mit der angegebenen ID gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {BetriebStammdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Betieb wurde erfolgreich angelegt. */ createBetrieb(data: BetriebStammdaten, schema: string): Promise; /** * Implementierung der DELETE-Methode removeBetrieb für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/remove * * Löscht einen oder mehrere Betriebe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Betriebe wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Betriebe zu löschen. * Code 404: Benötigte Information zum Betrieb wurden nicht in der DB gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ removeBetrieb(data: List, schema: string): Promise; /** * Implementierung der POST-Methode createSchuelerbetrieb für den Zugriff auf die URL https://{hostname}/db/{schema}/betriebe/schuelerbetrieb/new/schueler/{schueler_id : \d+}/betrieb/{betrieb_id: \d+} * * Erstellt einen neuen Schülerbetrieb und gibt ihn zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Schülerbetriebs besitzt. * * Mögliche HTTP-Antworten: * Code 200: Schülerbetrieb wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerBetriebsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Schülerbetrieb anzulegen. * Code 404: Kein Betrieb mit der angegebenen ID gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {SchuelerBetriebsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schueler_id - der Pfad-Parameter schueler_id * @param {number} betrieb_id - der Pfad-Parameter betrieb_id * * @returns Schülerbetrieb wurde erfolgreich angelegt. */ createSchuelerbetrieb(data: SchuelerBetriebsdaten, schema: string, schueler_id: number, betrieb_id: number): Promise; /** * Implementierung der GET-Methode getBKGymSchuelerAbiturdatenAusLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/bk/gym/schueler/{id : \d+}/laufbahn * * Liest die Abiturdaten des beruflichen Gymnasiums aus den Leistungsdaten des Schülers mit der angegebenen ID aus der Datenbank aus und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Abiturdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Abiturdaten aus der Laufbahn des angegebenen Schülers * - Mime-Type: application/json * - Rückgabe-Typ: BKGymAbiturdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Abiturdaten eines Schülers auszulesen. * Code 404: Kein Eintrag für einen Schüler mit Daten des beruflichen Gymnasiums für die angegebene ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Abiturdaten aus der Laufbahn des angegebenen Schülers */ getBKGymSchuelerAbiturdatenAusLeistungsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getBKGymSchuelerLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/bk/gym/schueler/{id : \d+}/leistungsdaten * * Liest die Leistungsdaten in Bezug auf das berufliche Gymnasium des Schülers mit der angegebene ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: BKGymLeistungen * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leistungsdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leistungsdaten des Schülers */ getBKGymSchuelerLeistungsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getClientConfig für den Zugriff auf die URL https://{hostname}/db/{schema}/client/config/{app} * * Liest die Konfigurationseinträge der angegebenen Client-Anwendung aus. * * Mögliche HTTP-Antworten: * Code 200: Die Key-Value-Paare der Konfigurationseinträge als Liste * - Mime-Type: application/json * - Rückgabe-Typ: BenutzerConfig * * @param {string} schema - der Pfad-Parameter schema * @param {string} app - der Pfad-Parameter app * * @returns Die Key-Value-Paare der Konfigurationseinträge als Liste */ getClientConfig(schema: string, app: string): Promise; /** * Implementierung der PUT-Methode setClientConfigGlobalKey für den Zugriff auf die URL https://{hostname}/db/{schema}/client/config/{app}/global/{key} * * Schreibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert in die globale Konfiguration. Dabei wird geprüft, ob der angemeldete Benutzer administrative Rechte hat. * * Mögliche HTTP-Antworten: * Code 204: Der Konfigurationseintrag wurde erfolgreich geschrieben * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {string} app - der Pfad-Parameter app * @param {string} key - der Pfad-Parameter key */ setClientConfigGlobalKey(data: string | null, schema: string, app: string, key: string): Promise; /** * Implementierung der GET-Methode getClientConfigUserKey für den Zugriff auf die URL https://{hostname}/db/{schema}/client/config/{app}/user/{key} * * Liest den Schlüsselwert aus der Konfiguration für den Client aus. Ist sowohl ein globaler als auch eine benutzerspezifischer Konfigurationseintrag unter den Name vorhanden,so wird der benutzerspezifische Eintrag zurückgegeben. Die benutzerspezifische Konfiguration kann somit globale Einstellungen 'überschreiben'. Ist kein Wert vorhanden, so wird ein leerer String zurückgegeben. * * Mögliche HTTP-Antworten: * Code 200: Der Wert des Konfigurationseintrags * - Mime-Type: application/json * - Rückgabe-Typ: String * * @param {string} schema - der Pfad-Parameter schema * @param {string} app - der Pfad-Parameter app * @param {string} key - der Pfad-Parameter key * * @returns Der Wert des Konfigurationseintrags */ getClientConfigUserKey(schema: string, app: string, key: string): Promise; /** * Implementierung der PUT-Methode setClientConfigUserKey für den Zugriff auf die URL https://{hostname}/db/{schema}/client/config/{app}/user/{key} * * Schreibt den Konfigurationseintrag der angegebenen Anwendung für den angebenen Schlüsselwert in die benutzerspezifische Konfiguration. * * Mögliche HTTP-Antworten: * Code 204: Der Konfigurationseintrag wurde erfolgreich geschrieben * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {string} app - der Pfad-Parameter app * @param {string} key - der Pfad-Parameter key */ setClientConfigUserKey(data: string | null, schema: string, app: string, key: string): Promise; /** * Implementierung der POST-Methode importKurs42Raeume für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/gost/kurs42/import/raeume * * Importiert die Räume aus Kurs 42 in das Schema mit dem angegebenen Namen. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Räume aus Kurs 42 * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 400: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Räume aus Kurs 42 zu importieren. * Code 404: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Import der Räume aus Kurs 42 */ importKurs42Raeume(data: FormData, schema: string): Promise; /** * Implementierung der POST-Methode importKurs42Blockung für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/gost/kurs42/import/zip * * Importiert die Kurs 42-Blockung aus dem übergebenen ZIP-File in das Schema mit dem angegebenen Namen. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Kurs 42-Blockung * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 400: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Kurs 42-Blockung zu importieren. * Code 404: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Import der Kurs 42-Blockung */ importKurs42Blockung(data: FormData, schema: string): Promise; /** * Implementierung der GET-Methode getGostLupoExportMDBFuerJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/gost/lupo/export/mdb/jahrgang/{jahrgang} * * Exportiert die Laufbahndaten für den übergebenen Jahrgang in eine LuPO-Lehrerdatei. * * Mögliche HTTP-Antworten: * Code 200: Die LuPO-Lehrerdatei * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der Benutzer hat keine Rechter zum Export der Laufbahndaten. * Code 500: Ein interner Server-Fehler beim Erzeugen der LuPO-Datei. * * @param {string} schema - der Pfad-Parameter schema * @param {string} jahrgang - der Pfad-Parameter jahrgang * * @returns Die LuPO-Lehrerdatei */ getGostLupoExportMDBFuerJahrgang(schema: string, jahrgang: string): Promise; /** * Implementierung der POST-Methode setGostLupoImportMDBFuerJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/gost/lupo/import/mdb/jahrgang/replace/{mode} * * Importiert die Laufbahndaten der übergebenen LuPO-Datenbank in das Schema mit dem angegebenen Namen. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Laufbahndaten * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 400: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Laufbahndaten zu importieren. * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {string} mode - der Pfad-Parameter mode * * @returns Der Log vom Import der Laufbahndaten */ setGostLupoImportMDBFuerJahrgang(data: FormData, schema: string, mode: string): Promise; /** * Implementierung der POST-Methode exportUntisBlockungGPU002GPU015GPU019 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/blockung/{id : \d+}/{sidvariante : \d+} * * Liefert einen Export für die Blockungsergebnisse als Liste mit drei Strings (GPU002.txt, GPU015.txt, GPU019.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste mit den Daten der drei GPUs * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {LongAndStringLists} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} sidvariante - der Pfad-Parameter sidvariante * * @returns Die Liste mit den Daten der drei GPUs */ exportUntisBlockungGPU002GPU015GPU019(data: LongAndStringLists, schema: string, id: number, sidvariante: number): Promise>; /** * Implementierung der POST-Methode exportUntisFachwahlenGPU015 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/fachwahlen/{id : \d+}/{sidvariante : \d+} * * Liefert einen Export für die Fachwahlen eines Schuljahresabschnittes (GPU015.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU015.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} sidvariante - der Pfad-Parameter sidvariante * * @returns Die GPU015.txt */ exportUntisFachwahlenGPU015(data: string | null, schema: string, id: number, sidvariante: number): Promise; /** * Implementierung der POST-Methode exportUntisFaecherGPU006 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/faecher/{id : \d+} * * Liefert einen Export für die Fächer- bzw. Kursdaten eines Schuljahresabschnittes (GPU006.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU006.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die GPU006.txt */ exportUntisFaecherGPU006(schema: string, id: number): Promise; /** * Implementierung der POST-Methode exportUntisKlassenGPU003 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/klassen/{id : \d+} * * Liefert einen Export für die Klassen eines Schuljahresabschnittes (GPU003.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU003.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die GPU003.txt */ exportUntisKlassenGPU003(schema: string, id: number): Promise; /** * Implementierung der POST-Methode exportUntisKlausurenGPU017 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/klausuren/{id : \d+}/{sidvariante : \d+} * * Liefert einen Export für die Klausurdaten eines Schuljahresabschnittes (GPU017.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU017.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} sidvariante - der Pfad-Parameter sidvariante * * @returns Die GPU017.txt */ exportUntisKlausurenGPU017(data: string | null, schema: string, id: number, sidvariante: number): Promise; /** * Implementierung der POST-Methode exportUntisLehrerGPU004 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/lehrer/{id : \d+} * * Liefert einen Export für die Lehrkräfte eines Schuljahresabschnittes (GPU004.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU004.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die GPU004.txt */ exportUntisLehrerGPU004(schema: string, id: number): Promise; /** * Implementierung der POST-Methode exportUntisSchienenGPU019 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/schienen/{id : \d+} * * Liefert einen Export für die Schienenzuordnungen eines Schuljahresabschnittes (GPU019.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU019.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die GPU019.txt */ exportUntisSchienenGPU019(data: string | null, schema: string, id: number): Promise; /** * Implementierung der POST-Methode exportUntisSchuelerGPU010 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/export/schueler/{id : \d+}/{sidvariante : \d+} * * Liefert einen Export für die Schüler eines Schuljahresabschnittes (GPU010.txt).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Exportieren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GPU010.txt * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 404: Es wurden nicht alle benötigten Daten für den Export gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} sidvariante - der Pfad-Parameter sidvariante * * @returns Die GPU010.txt */ exportUntisSchuelerGPU010(schema: string, id: number, sidvariante: number): Promise; /** * Implementierung der POST-Methode importStundenplanUntisGPU001 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/import/gpu001/{ingore_missing:[01]} * * Importiert den Untis-Stundenplan aus der übergebenen GPU001.txt in das Schema mit dem angegebenen Namen. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import des Untis-Stundenplans * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um den Untis-Stundenplan zu importieren. * Code 404: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} ingore_missing - der Pfad-Parameter ingore_missing * * @returns Der Log vom Import des Untis-Stundenplans */ importStundenplanUntisGPU001(data: FormData, schema: string, ingore_missing: number): Promise; /** * Implementierung der POST-Methode importUntisRaeumeGPU005 für den Zugriff auf die URL https://{hostname}/db/{schema}/datenaustausch/untis/import/gpu005 * * Importiert die Räume aus der Untis-Datei GPU005.txt in das Schema mit dem angegebenen Namen. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Räume aus der Untis-Datei GPU005.txt * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 400: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Räume aus der Untis-Datei GPU005.txt zu importieren. * Code 404: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Import der Räume aus der Untis-Datei GPU005.txt */ importUntisRaeumeGPU005(data: FormData, schema: string): Promise; /** * Implementierung der GET-Methode getEmailJobLog für den Zugriff auf die URL https://{hostname}/db/{schema}/email/email-jobs/{jobId}/log * * Liefert die gesammelten Logeinträge (Hinweise, Fehler) des angegebenen E-Mail-Jobs. * * Mögliche HTTP-Antworten: * Code 200: Log wurde ermittelt. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 404: Job nicht gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} jobId - der Pfad-Parameter jobId * * @returns Log wurde ermittelt. */ getEmailJobLog(schema: string, jobId: number): Promise; /** * Implementierung der GET-Methode getEmailJobStatus für den Zugriff auf die URL https://{hostname}/db/{schema}/email/email-jobs/{jobId}/status * * Liefert den aktuellen Status und Kennzahlen (Gesamt, Gesendete, Übersprungene, Fehler) des angegebenen E-Mail-Jobs. * * Mögliche HTTP-Antworten: * Code 200: Status wurde ermittelt. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 404: Job nicht gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} jobId - der Pfad-Parameter jobId * * @returns Status wurde ermittelt. */ getEmailJobStatus(schema: string, jobId: number): Promise; /** * Implementierung der GET-Methode getSMTPServerKonfiguration für den Zugriff auf die URL https://{hostname}/db/{schema}/email/smtp/server/konfiguration * * Gibt die SMTP-Server-Konfiguration der Schule zurück. * * Mögliche HTTP-Antworten: * Code 200: Die SMTP-Server-Konfiguration * - Mime-Type: application/json * - Rückgabe-Typ: SMTPServerKonfiguration * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten zu anzusehen. * * @param {string} schema - der Pfad-Parameter schema * * @returns Die SMTP-Server-Konfiguration */ getSMTPServerKonfiguration(schema: string): Promise; /** * Implementierung der PATCH-Methode patchSMTPServerKonfiguration für den Zugriff auf die URL https://{hostname}/db/{schema}/email/smtp/server/konfiguration * * Passt die SMTP-Server-Konfiguration an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schuldaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich in die SMTP-Server-Konfiguration integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten zu ändern. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchSMTPServerKonfiguration(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getENMDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/alle * * Liest die Daten des Externen Notenmoduls (ENM) aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) * - Mime-Type: application/json * - Rückgabe-Typ: ENMDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Es wurden nicht alle benötigten Daten für das Erstellen der ENM-Daten gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) */ getENMDaten(schema: string): Promise; /** * Implementierung der GET-Methode getENMDatenGZip für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/alle/gzip * * Liest die Daten des Externen Notenmoduls (ENM) aus der Datenbank und liefert diese GZip-komprimiert zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GZip-komprimierte ENM-JSON-Datei * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Es wurden nicht alle benötigten Daten für das Erstellen der ENM-Daten gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Die GZip-komprimierte ENM-JSON-Datei */ getENMDatenGZip(schema: string): Promise; /** * Implementierung der GET-Methode getENMLehrerInitialKennwoerter für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/alle/initial_kennwoerter * * Liefert eine Liste der Lehrer-IDs mit den zugehörigen Initialkennwörtern für Lehrer zurück, welche bei den Daten für das Externe Datenmodul (ENM) vorkommen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zur Administration der Notenmodul-Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste mit den Initialkennwörtern * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Initialkennwörter des ENM zu verwalten. * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Liste mit den Initialkennwörtern */ getENMLehrerInitialKennwoerter(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchENMSchuelerBemerkungen für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/bemerkungen/{id : \d+} * * Passt die Bemerkungen eines Schülers anhand der ENM-Daten an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung im Rahmen der Notenmodul-Konfiguration besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die daten zu ändern. * Code 404: Kein Eintrag mit der, im Patch angegebenen, ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchENMSchuelerBemerkungen(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode checkENMServer für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/check * * Prüft, ob der ENM-Server mit den hinterlegten Verbindungsdaten erreichbar ist.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der ENM-Server ist erreichbar. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Operation auszuführen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server, u.U. auch fehlende OAuth-Daten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Der ENM-Server ist erreichbar. */ checkENMServer(schema: string): Promise; /** * Implementierung der GET-Methode getENMServerConfig für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/config * * Ein Getter für die ENM-Server-Konfiguration. * * Mögliche HTTP-Antworten: * Code 200: Die Konfiguration konnte erfolgreich abgerufen werden. * - Mime-Type: application/json * - Rückgabe-Typ: ENMConfigResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: ENMConfigResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Operation auszuführen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: ENMConfigResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: ENMConfigResponse * Code 502: Fehler bei der Verbindung zum ENM-Server, u.U. auch fehlende OAuth-Daten. * - Mime-Type: application/json * - Rückgabe-Typ: ENMConfigResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Konfiguration konnte erfolgreich abgerufen werden. */ getENMServerConfig(schema: string): Promise; /** * Implementierung der POST-Methode setENMServerConfigElement für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/config * * Schreibt den Konfigurationseintrag für den angebenen Schlüsselwert in die Konfiguration. * * Mögliche HTTP-Antworten: * Code 204: Der Konfigurationseintrag wurde erfolgreich geschrieben * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Operation auszuführen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server, u.U. auch fehlende OAuth-Daten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {ENMServerConfigElement} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Konfigurationseintrag wurde erfolgreich geschrieben */ setENMServerConfigElement(data: ENMServerConfigElement, schema: string): Promise; /** * Implementierung der POST-Methode generateENMLehrerCredentials für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/credentials/generate * * Generiert Initial-Kennwörter für Lehrer für das externe Notenmodul, sofern diese noch keine haben. * * Mögliche HTTP-Antworten: * Code 204: Die Kennwörter und die Password-Hashes wurden erzeugt oder es war nichts zu tun. * Code 403: Der SVWS-Benutzer hat keine Rechte zum Erzeugen der Credentials. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema */ generateENMLehrerCredentials(schema: string): Promise; /** * Implementierung der POST-Methode resetENMLehrerPasswordToInitial für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/credentials/reset/{id : \d+} * * Setzt das Kennwort des Lehrers für das externe Notenmodul auf das Initial-Kennwort zurück. Ist noch kein Initialkennwort gesetzt, so wird ein neues erzeugt. * * Mögliche HTTP-Antworten: * Code 204: Das Initial-Kennwort wurde gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte zum Setzen des Kennwortes. * Code 404: Die ID des Lehrers ist in der DB nicht vorhanden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ resetENMLehrerPasswordToInitial(schema: string, id: number): Promise; /** * Implementierung der POST-Methode setENMLehrerPassword für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/credentials/set/{id : \d+} * * Setzt das Kennwort des Lehrers für das externe Notenmodul auf das übergebene Kennwort. Ist noch kein Initialkennwort gesetzt, so wird ein neues erzeugt, allerdings das übergebene Kennwort gesetzt. * * Mögliche HTTP-Antworten: * Code 204: Das Kennwort wurde gesetzt. * Code 400: Das Kennwort ist leer oder entspricht nicht den Minimal-Anforderungen. * Code 403: Der SVWS-Benutzer hat keine Rechte zum Setzen des Kennwortes. * Code 404: Die ID des Lehrers ist in der DB nicht vorhanden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ setENMLehrerPassword(data: string | null, schema: string, id: number): Promise; /** * Implementierung der GET-Methode downloadENMDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/download * * Importiert die Daten des Externen Notenmoduls und speichert diese in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) wurden heruntergeladen * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) wurden heruntergeladen */ downloadENMDaten(schema: string): Promise; /** * Implementierung der GET-Methode getENMDatenLeer für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/empty * * Liefert leere Daten des Externen Notenmoduls (ENM). * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) * - Mime-Type: application/json * - Rückgabe-Typ: ENMDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um auf die API zuzugreifen. * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) */ getENMDatenLeer(schema: string): Promise; /** * Implementierung der POST-Methode importENMDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/import * * Importiert die übergebenen ENM-Daten. Dabei wird die Aktualität der zu importierenden Daten anhand der Zeitstempel in den ENM-Daten geprüft. * * Mögliche HTTP-Antworten: * Code 204: Die ENM-Daten wurden erfolgreich importiert. * Code 400: Die ENM-Daten sind nicht korrekt. * Code 403: Der SVWS-Benutzer hat keine Rechte zum importieren. * Code 404: Es wurden nicht alle benötigten Daten für den Abgleich in der DB gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {ENMDaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ importENMDaten(data: ENMDaten, schema: string): Promise; /** * Implementierung der POST-Methode importENMDatenGZip für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/import/gzip * * Importiert die übergebenen ENM-Daten. Dabei wird die Aktualität der zu importierenden Daten anhand der Zeitstempel in den ENM-Daten geprüft. * * Mögliche HTTP-Antworten: * Code 204: Die ENM-Daten wurden erfolgreich importiert. * Code 400: Die ENM-Daten sind nicht korrekt. * Code 403: Der SVWS-Benutzer hat keine Rechte zum importieren. * Code 404: Es wurden nicht alle benötigten Daten für den Abgleich in der DB gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ importENMDatenGZip(data: FormData, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerENMDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/lehrer/{id : \d+} * * Liest die Daten des Externen Notenmoduls (ENM) des Lehrers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) des Lehrers * - Mime-Type: application/json * - Rückgabe-Typ: ENMDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Externen Notenmoduls (ENM) des Lehrers */ getLehrerENMDaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchENMLeistung für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/leistung * * Passt die Leistungsdaten eines Schüler anhand der ENM-Daten an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung im Rahmen der Notenmodul-Konfiguration besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die daten zu ändern. * Code 404: Kein Eintrag mit der, im Patch angegebenen, ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchENMLeistung(data: Partial, schema: string): Promise; /** * Implementierung der PATCH-Methode patchENMSchuelerLernabschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/lernabschnitt * * Passt die Lernabschnittsdaten eines Schüler anhand der ENM-Daten an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung im Rahmen der Notenmodul-Konfiguration besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die daten zu ändern. * Code 404: Kein Eintrag mit der, im Patch angegebenen, ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchENMSchuelerLernabschnitt(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode resetENMServer für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/reset * * Leert die Daten des Externen Notenmoduls (ENM).Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) wurden geleert. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server, u.U. auch fehlende OAuth-Daten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) wurden geleert. */ resetENMServer(schema: string): Promise; /** * Implementierung der GET-Methode setupENMServer für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/setup * * Dieser Aufruf initialisert den ENM-Server beim ersten Aufruf. Weitere Aufrufe führen zu einem Fehler. * * Mögliche HTTP-Antworten: * Code 200: Der Stand des Setups, true, wurde initialisiert, false ist bereits initialisiert * - Mime-Type: application/json * - Rückgabe-Typ: Boolean * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Operation auszuführen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 409: Der TLS-Zertifikat des ENM-Server wird nicht vertraut. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server, u.U. auch fehlende OAuth-Daten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Stand des Setups, true, wurde initialisiert, false ist bereits initialisiert */ setupENMServer(schema: string): Promise; /** * Implementierung der GET-Methode synchronizeENMDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/synchronize * * Liest die Daten des Externen Notenmoduls (ENM) aller Lehrer aus der Datenbank und lädt diese als ZIP beim ENM hoch, lädt danach die Daten des ENM runter und speichert diese in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) wurden synchronisiert * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) wurden synchronisiert */ synchronizeENMDaten(schema: string): Promise; /** * Implementierung der PATCH-Methode patchENMTeilleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/teilleistung * * Passt die Teilleistungsdaten eines Schüler anhand der ENM-Daten an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung im Rahmen der Notenmodul-Konfiguration besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die daten zu ändern. * Code 404: Kein Eintrag mit der, im Patch angegebenen, ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchENMTeilleistung(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode truncateENMServer für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/truncate * * Leert die Daten des Externen Notenmoduls (ENM), einschließlich der Benutzerdaten.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) wurden geleert. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server, u.U. auch fehlende OAuth-Daten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) wurden geleert. */ truncateENMServer(schema: string): Promise; /** * Implementierung der GET-Methode uploadENMDaten für den Zugriff auf die URL https://{hostname}/db/{schema}/enm/upload * * Liest die Daten des Externen Notenmoduls (ENM) aller Lehrer aus der Datenbank und lädt diese als ZIP beim ENM hoch.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Notendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Externen Notenmoduls (ENM) wurden hochgeladen * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 401: Die Authorisierung beim ENM-Server ist fehlgeschlagen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten des ENM auszulesen. * Code 404: Keine ENM-Serverdaten gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Interner Serverfehler * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 502: Fehler bei der Verbindung zum ENM-Server * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Daten des Externen Notenmoduls (ENM) wurden hochgeladen */ uploadENMDaten(schema: string): Promise; /** * Implementierung der GET-Methode getEntlassgruende für den Zugriff auf die URL https://{hostname}/db/{schema}/entlassgruende * * Gibt die Entlassgründe zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Entlassgründe. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Entlassgründe. */ getEntlassgruende(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchEntlassgrund für den Zugriff auf die URL https://{hostname}/db/{schema}/entlassgruende/{id : \d+} * * Patched den Entlassgrund mit der angegebenen ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchEntlassgrund(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addEntlassgrund für den Zugriff auf die URL https://{hostname}/db/{schema}/entlassgruende/create * * Erstellt einen neuen Entlassgrund, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Der Entlassgrund wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: KatalogEntlassgrund * Code 403: Der SVWS-Benutzer hat keine Rechte, um Entlassgründe anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Entlassgrund wurde erfolgreich hinzugefügt. */ addEntlassgrund(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteEntlassgruende für den Zugriff auf die URL https://{hostname}/db/{schema}/entlassgruende/delete/multiple * * Entfernt mehrere Entlassgründe, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Entlassgründe zu entfernen. * Code 404: Entlassgründe nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteEntlassgruende(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getErzieher für den Zugriff auf die URL https://{hostname}/db/{schema}/erzieher/ * * Erstellt eine Liste aller in der Datenbank vorhandenen Erzieher unter Angabe der ID, des Kürzels, des Vor- und Nachnamens, Erzieherart, Kontaktdaten, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Erzieherdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Erzieher-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherdaten anzusehen. * Code 404: Keine Erzieher-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Erzieher-Listen-Einträgen */ getErzieher(schema: string): Promise>; /** * Implementierung der GET-Methode getErzieherStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/erzieher/{id : \d+}/stammdaten * * Liest die Stammdaten des Erziehers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Erzieherdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten des Erziehers * - Mime-Type: application/json * - Rückgabe-Typ: ErzieherStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherdaten anzusehen. * Code 404: Kein Erzieher-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Stammdaten des Erziehers */ getErzieherStammdaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchErzieherStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/erzieher/{id : \d+}/stammdaten * * Passt die Erzieher-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dieser Patch wird vom Client zum Anpassen der Daten an beiden Positionen im Eintrag verwendet.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Erzieherdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Erzieher-Stammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherdaten zu ändern. * Code 404: Kein Erzieher-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchErzieherStammdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchErzieherStammdatenZweitePosition für den Zugriff auf die URL https://{hostname}/db/{schema}/erzieher/{id : \d+}/stammdaten/{pos : [12]} * * Passt die Erzieher-Stammdaten zu der angegebenen ID an der zweiten Postion im Eintrag an und speichert das Ergebnis in der Datenbank. Dieser API-Call dient hauptsächlich dazu einen neuen Erzieher an der zweiten Postion im Eintrag zu patchen. Der Client schickt im Param die entsprechende Postion mit.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Erzieherdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Erzieher-Stammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherdaten zu ändern. * Code 404: Kein Erzieher-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} pos - der Pfad-Parameter pos */ patchErzieherStammdatenZweitePosition(data: Partial, schema: string, id: number, pos: number): Promise; /** * Implementierung der DELETE-Methode deleteErzieherStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/erzieher/stammdaten/multiple * * Entfernt einen oder mehrerer Erziehungsberechtigte bei Schülern, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Erziehungsberechtigte wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erziehungsberechtigte zu entfernen. * Code 404: Mindestens ein Erziehungsberechtigter ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Erziehungsberechtigte wurden erfolgreich entfernt. */ deleteErzieherStammdaten(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode exportSQLite für den Zugriff auf die URL https://{hostname}/db/{schema}/export/sqlite * * Exportiert das aktuelle Schema in eine neu erstellte SQLite-Datenbank. Der Aufruf erfordert administrative Rechte. * * Mögliche HTTP-Antworten: * Code 200: Der Export der SQLite-Datenbank * - Mime-Type: application/vnd.sqlite3 * - Rückgabe-Typ: ApiFile * Code 403: Das Schema darf nicht exportiert werden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Export der SQLite-Datenbank */ exportSQLite(schema: string): Promise; /** * Implementierung der GET-Methode getFaecher für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/ * * Erstellt eine Liste aller in der Datenbank vorhanden Fächer unter Angabe der ID, des Kürzels, des verwendeten Statistik-Kürzels, der Bezeichnung des Faches, ob es ein Fach der Oberstufe ist, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Fächer-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fächerdaten anzusehen. * Code 404: Keine Fächer-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Fächer-Listen-Einträgen */ getFaecher(schema: string): Promise>; /** * Implementierung der GET-Methode getFach für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/{id : \d+} * * Liest die Daten des Faches zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Faches * - Mime-Type: application/json * - Rückgabe-Typ: FachDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fächerdaten anzusehen. * Code 404: Kein Fach-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Faches */ getFach(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchFach für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/{id : \d+} * * Passt das Fach mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Fächern besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchFach(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteFach für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/{id : \d+} * * Entfernt ein Fach. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen eines Faches hat. * * Mögliche HTTP-Antworten: * Code 200: Das Fach wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: FachDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um ein Fach zu löschen. * Code 404: Kein Fach vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Das Fach wurde erfolgreich entfernt. */ deleteFach(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogFachgruppenEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/fachgruppe/{id : \d+} * * Gibt den Fachgruppen-Katalog-Eintrag für die angegebene ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Fachgruppen-Katalog-Eintrag für die angegebene ID. * - Mime-Type: application/json * - Rückgabe-Typ: FachgruppeKatalogEintrag * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Kein Fachgruppen-Katalog-Eintrag für die angegebene ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Fachgruppen-Katalog-Eintrag für die angegebene ID. */ getKatalogFachgruppenEintrag(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogFachgruppen für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/fachgruppen * * Gibt den Katalog aller Fachgruppen aller Schulformen zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog aller Fachgruppen aller Schulformen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Fachgruppen gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog aller Fachgruppen aller Schulformen. */ getKatalogFachgruppen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogFaecher für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/faecher * * Erstellt eine Liste aller in dem Katalog vorhanden zulässigen Fächer. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Fächer-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Fach-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Fächer-Katalog-Einträgen */ getKatalogFaecher(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogBilingualeSprachen für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/sprachen/bilingual * * Gibt den Katalog der bilingualen Sprachen für die Schulform dieser Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der bilingualen Sprachen für die Schulform dieser Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine bilingualen Sprachen für die Schulform dieser Schule gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der bilingualen Sprachen für die Schulform dieser Schule. */ getKatalogBilingualeSprachen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogBilingualeSprachenEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/sprachen/bilingual/{id : \d+} * * Gibt den Katalog-Eintrag einer bilingualen Sprache für die angegebene ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog-Eintrag einer bilingualen Sprache für die angegebene ID. * - Mime-Type: application/json * - Rückgabe-Typ: BilingualeSpracheKatalogEintrag * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Kein Katalog-Eintrag einer bilingualen Sprache für die angegebene ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Katalog-Eintrag einer bilingualen Sprache für die angegebene ID. */ getKatalogBilingualeSprachenEintrag(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogBilingualeSprachenAlle für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/sprachen/bilingual/alle * * Gibt den Katalog aller bilingualen Sprachen aller Schulformen zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog aller bilingualen Sprachen aller Schulformen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Fachgruppen gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog aller bilingualen Sprachen aller Schulformen. */ getKatalogBilingualeSprachenAlle(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSprachpruefungsniveaus für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/sprachen/pruefungsniveaus * * Gibt den Katalog der Sprachprüfungsniveaus zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Sprachprüfungsniveaus. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Fachgruppen gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Sprachprüfungsniveaus. */ getKatalogSprachpruefungsniveaus(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSprachreferenzniveaus für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/allgemein/sprachen/referenzniveaus * * Gibt den Katalog der Sprachreferenzniveaus zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Sprachreferenzniveaus. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Fachgruppen gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Sprachreferenzniveaus. */ getKatalogSprachreferenzniveaus(schema: string): Promise>; /** * Implementierung der POST-Methode addFach für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/create * * Erstellt ein neues Fach und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Faches besitzt. * * Mögliche HTTP-Antworten: * Code 201: Das Fach wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: FachDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um ein Fach anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Das Fach wurde erfolgreich hinzugefügt. */ addFach(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteFaecher für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/delete/multiple * * Entfernt mehrere Fächer. Dabei wird geprüft, ob alle Vorbedingungen zum Entfernender Fächer erfüllt sind und der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fächer zu entfernen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteFaecher(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getFachgruppen für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/fachgruppen * * Gibt den Katalog der Fachgruppen für die Schulform dieser Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Fachgruppen für die Schulform dieser Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Fachgruppen für die Schulform dieser Schule gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Fachgruppen für die Schulform dieser Schule. */ getFachgruppen(schema: string): Promise>; /** * Implementierung der POST-Methode setFaecherSortierungSekII für den Zugriff auf die URL https://{hostname}/db/{schema}/faecher/sortierung/setSekII * * Setzte eine Sortierung für die Fächer auf eine Standard-Sortierung für die Sekundarstufe II.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen von Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Sortierung wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fächerdaten anzupassen. * Code 404: Keine Fächer-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema */ setFaecherSortierungSekII(schema: string): Promise; /** * Implementierung der GET-Methode getKatalogFoerderschwerpunkte für den Zugriff auf die URL https://{hostname}/db/{schema}/foerderschwerpunkte * * Erstellt eine Liste aller in dem Katalog vorhanden Förderschwerpunkte unter Angabe der ID, eines Kürzels und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Förderschwerpunkte-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Förderschwerpunkte-Katalog-Einträgen */ getKatalogFoerderschwerpunkte(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogFoerderschwerpunkt für den Zugriff auf die URL https://{hostname}/db/{schema}/foerderschwerpunkte/{id : \d+} * * Liest die Daten des Förderschwerpunktes zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Förderschwerpunktes * - Mime-Type: application/json * - Rückgabe-Typ: FoerderschwerpunktEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Kein Förderschwerpunkt-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Förderschwerpunktes */ getKatalogFoerderschwerpunkt(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addKatalogFoerderschwerpunkt für den Zugriff auf die URL https://{hostname}/db/{schema}/foerderschwerpunkte/create * * Erstellt einen neuen Förderschwerpunkt und gibt das erstellte Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer Förderschwerpunkte besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Förderschwerpunkt wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: FoerderschwerpunktEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um Förderschwerpunkte anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Förderschwerpunkt wurde erfolgreich hinzugefügt. */ addKatalogFoerderschwerpunkt(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteKatalogFoerderschwerpunkte für den Zugriff auf die URL https://{hostname}/db/{schema}/foerderschwerpunkte/delete/multiple * * Entfernt mehrere Förderschwerpunkte, insofern, die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Förderschwerpunkte wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Förderschwerpunkte nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Förderschwerpunkte wurden erfolgreich entfernt. */ deleteKatalogFoerderschwerpunkte(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getGesamtschuleSchuelerPrognoseLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gesamtschule/schueler/{id : \d+}/prognose_leistungsdaten * * Liest die Leistungsdaten des aktuellen Lernabschnittes in Bezug auf die Prognose- bzw. Abschlussberechnung in der Sek I der Gesamtschule des Schülers mit der angegebene ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: GEAbschlussFaecher * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leistungsdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leistungsdaten des Schülers */ getGesamtschuleSchuelerPrognoseLeistungsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGesamtschuleSchuelerPrognosLeistungsdatenFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/gesamtschule/schueler/{id : \d+}/prognose_leistungsdaten/abschnitt/{abschnittID : \d+} * * Liest die Leistungsdaten des angegebenen Lernabschnittes in Bezug auf die Prognose- bzw. Abschlussberechnung in der Sek I der Gesamtschule des Schülers mit der angegebene ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: GEAbschlussFaecher * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leistungsdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} abschnittID - der Pfad-Parameter abschnittID * * @returns Die Leistungsdaten des Schülers */ getGesamtschuleSchuelerPrognosLeistungsdatenFuerAbschnitt(schema: string, id: number, abschnittID: number): Promise; /** * Implementierung der POST-Methode getGostAbiturBelegpruefungEF1 für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abitur/belegpruefung/EF1 * * Prüft anhand der übergeben Abiturdaten, ob die Belegung in den Abiturdaten korrekt ist oder nicht. Es werden ggf. auch Belegungsfehler und Hinweise zur Belegung zurückgegeben. * * Mögliche HTTP-Antworten: * Code 200: Das Ergebnis der Belegprüfung, ggf. mit Belegungsfehlern * - Mime-Type: application/json * - Rückgabe-Typ: GostBelegpruefungErgebnis * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Belegprüfung durchzuführen. * Code 404: Es wurden keine Fächerdaten zur gymnasialen Oberstufe gefunden * * @param {Abiturdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Das Ergebnis der Belegprüfung, ggf. mit Belegungsfehlern */ getGostAbiturBelegpruefungEF1(data: Abiturdaten, schema: string): Promise; /** * Implementierung der POST-Methode getGostAbiturBelegpruefungGesamt für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abitur/belegpruefung/gesamt * * Prüft anhand der übergeben Abiturdaten, ob die Belegung in den Abiturdaten korrekt ist oder nicht. Es werden ggf. auch Belegungsfehler und Hinweise zur Belegung zurückgegeben. * * Mögliche HTTP-Antworten: * Code 200: Das Ergebnis der Belegprüfung, ggf. mit Belegungsfehlern * - Mime-Type: application/json * - Rückgabe-Typ: GostBelegpruefungErgebnis * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Belegprüfung durchzuführen. * Code 404: Es wurden keine Fächerdaten zur gymnasialen Oberstufe gefunden * * @param {Abiturdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Das Ergebnis der Belegprüfung, ggf. mit Belegungsfehlern */ getGostAbiturBelegpruefungGesamt(data: Abiturdaten, schema: string): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgaenge für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgaenge * * Liefert eine Liste aller Abiturjahrgänge, welche in der Datenbank für die Laufbahnplanung angelegt sind.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen von Kataloginformationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der Abiturjahrgänge. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Liste der Abiturjahrgänge auszulesen. * Code 404: Kein Abiturjahrgang gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Liste der Abiturjahrgänge. */ getGostAbiturjahrgaenge(schema: string): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgaengeFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgaenge/{idAbschnitt : \d+} * * Liefert eine Liste aller Abiturjahrgänge, welche in der Datenbank für die Laufbahnplanung angelegt sind.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen von Kataloginformationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der Abiturjahrgänge. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Liste der Abiturjahrgänge auszulesen. * Code 404: Kein Abiturjahrgang gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} idAbschnitt - der Pfad-Parameter idAbschnitt * * @returns Die Liste der Abiturjahrgänge. */ getGostAbiturjahrgaengeFuerAbschnitt(schema: string, idAbschnitt: number): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+} * * Liest die Grunddaten des Jahrgangs der gymnasialen Oberstufe zu dem Jahr, in welchem der Jahrgang Abitur machen wird, aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Jahrgangsinformationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Grunddaten des Jahrgangs der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostJahrgangsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Grunddaten der Gymnasialen Oberstufe anzusehen. * Code 404: Kein Eintrag für einen Jahrgang der gymnasialen Oberstufe mit dem angegebenen Abiturjahr gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Die Grunddaten des Jahrgangs der gymnasialen Oberstufe */ getGostAbiturjahrgang(schema: string, abiturjahr: number): Promise; /** * Implementierung der PATCH-Methode patchGostAbiturjahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+} * * Passt die Daten des Jahrganges der gymnasialen Oberstufe zu dem Jahr an, in welchem der Jahrgang Abitur machen wird. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Jahrgangsinformationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Jahrgangsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Jahrgangsdaten zu ändern. * Code 404: Kein Abiturjahrgangs-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr */ patchGostAbiturjahrgang(data: Partial, schema: string, abiturjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangAbiturdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/abiturdaten * * Liefert zu dem Abiturjahrgang die zugehörigen Abiturdaten aus den Abiturtabellen und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Abiturdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Abiturdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Abiturdaten anzusehen. * Code 404: Kein Abiturjahrgang gefunden * - Mime-Type: text/plain * - Rückgabe-Typ: String * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Die Abiturdaten des Schülers */ getGostAbiturjahrgangAbiturdaten(schema: string, abiturjahr: number): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgangBelegpruefungsergebnisseEF1 für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/belegpruefung/EF1 * * Gibt die (Fehler-)Rückmeldungen der EF1-Belegprüfung zu den Schüler-Laufbahnen eines Abitur-Jahrganges der gymnasialen Oberstufe zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung dazu hat. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste mit den Schülern und den zugehörigen Belegprüfungsfehlern. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Rückmeldungen abzufragen. * Code 404: Keine und unvollständige Daten für die Belegprüfung gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Eine Liste mit den Schülern und den zugehörigen Belegprüfungsfehlern. */ getGostAbiturjahrgangBelegpruefungsergebnisseEF1(schema: string, abiturjahr: number): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgangBelegpruefungsergebnisseGesamt für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/belegpruefung/gesamt * * Gibt die (Fehler-)Rückmeldungen der Gesamt-Belegprüfung zu den Schüler-Laufbahnen eines Abitur-Jahrganges der gymnasialen Oberstufe zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung dazu hat. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste mit den Schülern und den zugehörigen Belegprüfungsfehlern. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Rückmeldungen abzufragen. * Code 404: Keine und unvollständige Daten für die Belegprüfung gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Eine Liste mit den Schülern und den zugehörigen Belegprüfungsfehlern. */ getGostAbiturjahrgangBelegpruefungsergebnisseGesamt(schema: string, abiturjahr: number): Promise>; /** * Implementierung der POST-Methode addGostAbiturjahrgangBeratungslehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/beratungslehrer/add * * Fügt einen Lehrer als Beratungslehrer zu einem Abiturjahrgang der Gymnasialen Oberstufe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen eines Beratungslehrers hat. * * Mögliche HTTP-Antworten: * Code 200: Der hinzugefügte Beratungslehrer * - Mime-Type: application/json * - Rückgabe-Typ: GostBeratungslehrer * Code 400: Der Lehrer ist bereits als Beratungslehrer eingetragen. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Beratungslehrer hinzuzufügen. * Code 404: Der Abiturjahrgang oder der Lehrer ist nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {number | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Der hinzugefügte Beratungslehrer */ addGostAbiturjahrgangBeratungslehrer(data: number | null, schema: string, abiturjahr: number): Promise; /** * Implementierung der POST-Methode removeGostAbiturjahrgangBeratungslehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/beratungslehrer/remove * * Entfernt einen Lehrer als Beratungslehrer aus einem Abiturjahrgang der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen eines Beratungslehrers hat. * * Mögliche HTTP-Antworten: * Code 200: Der entfernte Beratungslehrer * - Mime-Type: application/json * - Rückgabe-Typ: GostBeratungslehrer * Code 400: Der Lehrer ist nicht als Beratungslehrer eingetragen. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Beratungslehrer zu entfernen. * Code 404: Der Abiturjahrgang oder der Lehrer ist nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {number | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Der entfernte Beratungslehrer */ removeGostAbiturjahrgangBeratungslehrer(data: number | null, schema: string, abiturjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangFach für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fach/{id : \d+} * * Liefert die Informationen bezüglich eines Abiturjahrgangs der gymnasialen Oberstufe zu dem Fach mit der angegebenen ID. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Fachinformationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Faches bezüglich eines Abiturjahrgangs der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostFach * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachinformationen der Gymnasialen Oberstufe anzusehen. * Code 404: Kein Eintrag für das Fach der gymnasialen Oberstufe mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Faches bezüglich eines Abiturjahrgangs der gymnasialen Oberstufe */ getGostAbiturjahrgangFach(schema: string, abiturjahr: number, id: number): Promise; /** * Implementierung der PATCH-Methode patchGostAbiturjahrgangFach für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fach/{id : \d+} * * Passt die Daten eines Faches in Bezug auf den Abiturjahrgang der Gymnasiale Oberstufe an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Fachinformationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Fachinformationen integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachdaten zu ändern. * Code 404: Kein Fach-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} id - der Pfad-Parameter id */ patchGostAbiturjahrgangFach(data: Partial, schema: string, abiturjahr: number, id: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangFachkombinationen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachkombinationen * * Erstellt eine Liste mit den Informationen zu den Fachkombinationen für die Laufbahnplanung des Abitur-Jahrganges der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Fachkombinationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der Fachkombinationen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachkombinationen anzusehen. * Code 404: Keine Fachkombinationen gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Die Liste der Fachkombinationen */ getGostAbiturjahrgangFachkombinationen(schema: string, abiturjahr: number): Promise>; /** * Implementierung der POST-Methode addGostAbiturjahrgangFachkombination für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachkombinationen/add/{typ : \d+} * * Fügt eine Regel zu einer Fachkombination der Gymnasialen Oberstufe bei dem angegebenen Abiturjahrgang hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer solchen Fachkombination hat. * * Mögliche HTTP-Antworten: * Code 200: Die Regel zur Fachkombination bezüglich der gymnasialen Oberstufe wurde erstellt * - Mime-Type: application/json * - Rückgabe-Typ: GostJahrgangFachkombination * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Regel für eine Fachkombination hinzuzufügen. * Code 404: Abiturjahr nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} typ - der Pfad-Parameter typ * * @returns Die Regel zur Fachkombination bezüglich der gymnasialen Oberstufe wurde erstellt */ addGostAbiturjahrgangFachkombination(schema: string, abiturjahr: number, typ: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangFachwahl für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachwahl/{fachid : \d+} * * Liest für die gymnasiale Oberstufe die Fachwahlen zu einem Fach von dem angegebenen Abiturjahrgang aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Fachwahlen der gymnasialen Oberstufe für das angegebene Fach und den angegebenen Abiturjahrgang * - Mime-Type: application/json * - Rückgabe-Typ: GostSchuelerFachwahl * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen der Gymnasialen Oberstufe eines Abiturjahrgang auszulesen. * Code 404: Kein Eintrag für einen Abiturjahrgang mit Laufbahnplanungsdaten der gymnasialen Oberstufe für die angegebene ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} fachid - der Pfad-Parameter fachid * * @returns Die Fachwahlen der gymnasialen Oberstufe für das angegebene Fach und den angegebenen Abiturjahrgang */ getGostAbiturjahrgangFachwahl(schema: string, abiturjahr: number, fachid: number): Promise; /** * Implementierung der PATCH-Methode patchGostAbiturjahrgangFachwahl für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachwahl/{fachid : \d+} * * Passt die Fachwahl der Vorlage des angegebenen Abiturjahrgangs in Bezug auf ein Fach der Gymnasiale Oberstufe an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 203: Der Patch wurde erfolgreich in die Fachwahlen integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachwahlen zu ändern. * Code 404: Kein Eintrag für einen Abiturjahrgang mit Laufbahnplanungsdaten der gymnasialen Oberstufe oder für das Fach gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} fachid - der Pfad-Parameter fachid */ patchGostAbiturjahrgangFachwahl(data: Partial, schema: string, abiturjahr: number, fachid: number): Promise; /** * Implementierung der POST-Methode resetGostAbiturjahrgangFachwahlen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachwahl/reset * * Setzt die Fachwahlen in der Vorlage für eine Laufbahnplanung in dem angegebenen Abiturjahrgang zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Zurücksetzen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 203: Die Fachwahlen wurden erfolgreich zurückgesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen zurückzusetzen. * Code 404: Der Abiturjahrgang wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr */ resetGostAbiturjahrgangFachwahlen(schema: string, abiturjahr: number): Promise; /** * Implementierung der POST-Methode resetGostAbiturjahrgangSchuelerFachwahlen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachwahl/schueler/reset * * Setzt die Fachwahlen aller Schüler des angegebenen Abiturjahrgang zurück. Die Fachwahlen werden von allen Halbjahren ohn Leistungsdaten entfernt. Sollten danach keine Fachwahlen bei einem Schüler vorhanden sein, so wird die Laufbahnplanung mit der Fachwahlen-Vorlage des Abiturjahrgangs initialisiert.Außerdem wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Zurücksetzen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 203: Die Fachwahlen wurden erfolgreich zurückgesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen zurückzusetzen. * Code 404: Der Abiturjahrgang wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr */ resetGostAbiturjahrgangSchuelerFachwahlen(schema: string, abiturjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangFachwahlen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachwahlen * * Erstellt eine Liste aller in der Datenbank für den angegebenen Abitur-Jahrgang vorhanden Fachwahlen der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Fachwahlen * - Mime-Type: application/json * - Rückgabe-Typ: GostJahrgangFachwahlen * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachwahlen anzusehen. * Code 404: Keine Fachwahlen gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Eine Liste der Fachwahlen */ getGostAbiturjahrgangFachwahlen(schema: string, abiturjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangFachwahlstatistik für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/fachwahlstatistik * * Erstellt eine Liste aller in der Datenbank für den angegebenen Abitur-Jahrgang vorhanden Fachwahlen der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Fachwahlstatistik * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachwahlen anzusehen. * Code 404: Keine Fachwahlen gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Eine Fachwahlstatistik */ getGostAbiturjahrgangFachwahlstatistik(schema: string, abiturjahr: number): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgangFaecher für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/faecher * * Erstellt eine Liste aller in der Datenbank vorhanden Fächer der gymnasialen Oberstufe, welche für den angegebenen Abitur-Jahrgang festgelegt wurden.. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Fächer-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fächerdaten anzusehen. * Code 404: Keine Fächer-Einträge gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Eine Liste von Fächer-Listen-Einträgen */ getGostAbiturjahrgangFaecher(schema: string, abiturjahr: number): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgangHalbjahrFachwahlen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/halbjahr/{halbjahr : \d+}/fachwahlen * * Erstellt eine Liste aller in der Datenbank für den angegebenen Abitur-Jahrgang vorhanden Fachwahlen der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Fächerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Fachwahlen * - Mime-Type: application/json * - Rückgabe-Typ: GostJahrgangFachwahlenHalbjahr * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachwahlen anzusehen. * Code 404: Keine Fachwahlen gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Eine Liste der Fachwahlen */ getGostAbiturjahrgangHalbjahrFachwahlen(schema: string, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangLaufbahndaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/laufbahndaten * * Liefert zu dem Abiturjahrgang die zugehörigen Abiturdaten aus den Laufbahndaten und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Laufbahndaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Laufbahndaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Laufbahndaten anzusehen. * Code 404: Kein Abiturjahrgang gefunden * - Mime-Type: text/plain * - Rückgabe-Typ: String * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Die Laufbahndaten des Schülers */ getGostAbiturjahrgangLaufbahndaten(schema: string, abiturjahr: number): Promise>; /** * Implementierung der GET-Methode getGostAbiturjahrgangLaufbahnplanung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/laufbahnplanung * * Liest die Laufbahnplanungsdaten für die gymnasiale Oberstufe zu dem Abiturjahrgang aus der Datenbank aus und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Laufbahnplanungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Laufbahnplanungsdaten der gymnasialen Oberstufe des angegebenen Abiturjahrgangs * - Mime-Type: application/json * - Rückgabe-Typ: Abiturdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Laufbahnplanungsdaten der Gymnasialen Oberstufe eines Abiturjahrgangs auszulesen. * Code 404: Kein Eintrag für den angegebenen Abiturjahrgangs mit Laufbahnplanungsdaten der gymnasialen Oberstufe gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Die Laufbahnplanungsdaten der gymnasialen Oberstufe des angegebenen Abiturjahrgangs */ getGostAbiturjahrgangLaufbahnplanung(schema: string, abiturjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangSchueler für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : -?\d+}/schueler * * Erstellt eine Liste aller Schüler, welche zu dem angegebenen Abitur-Jahrgang gehören (ohne Informationen zu Kursen). Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schüler-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Keine Schüler gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Eine Liste von Schüler-Listen-Einträgen */ getGostAbiturjahrgangSchueler(schema: string, abiturjahr: number): Promise>; /** * Implementierung der DELETE-Methode deleteGostAbiturjahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : \d+} * * Entfernt den Abiturjahrgang, sofern er nicht abgeschlossen ist oder bereits Leistungsdaten bei Schülern eingetragen sind. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Abiturjahrgang wurde wurde erfolgreich entfernt. * Code 400: Es wurde versucht einen Abiturjahrgang, der abgeschlossen ist oder für den bereits Leistungsdaten bei Schülern eingetragen sind, zu entfernen. * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Abiturjahrgang zu entfernen. * Code 404: Der Abiturjahrgang wurde nicht gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr */ deleteGostAbiturjahrgang(schema: string, abiturjahr: number): Promise; /** * Implementierung der GET-Methode getGostAbiturjahrgangBlockungsliste für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : \d+}/{halbjahr : \d+}/blockungen * * Erstellt eine Liste aller in der Datenbank vorhanden Blockungen der gymnasialen Oberstufe, welche für den angegebenen Abitur-Jahrgang und das angegebene Halbjahr festgelegt wurden.. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Blockungs-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Blockungsdaten anzusehen. * Code 404: Keine Blockungs-Einträge gefunden oder keine gymnasiale Oberstufe bei der Schulform vorhanden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Eine Liste von Blockungs-Listen-Einträgen */ getGostAbiturjahrgangBlockungsliste(schema: string, abiturjahr: number, halbjahr: number): Promise>; /** * Implementierung der POST-Methode createGostAbiturjahrgangBlockung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/{abiturjahr : \d+}/{halbjahr : \d+}/blockungen/new * * Erstellt eine neue Blockung und gibt den Listeneintrag für die Blockung zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen der Blockungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Blockung wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungListeneintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Blockung anzulegen. * Code 404: Keine Fachwahlinformationen zum Anlegen einer Blockung gefunden * Code 409: Das Abiturjahr oder das Halbjahr ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Die Blockung wurde erfolgreich angelegt. */ createGostAbiturjahrgangBlockung(schema: string, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der POST-Methode createGostAbiturjahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/abiturjahrgang/new/{schuljahresabschnittsid}/{jahrgangid} * * Erstellt einen neuen Abiturjahrgang und gibt das Abiturjahr zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eine Abiturjahrgangs besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Abiturjahrgang wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: Integer * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Abiturjahrgang anzulegen. * Code 404: Keine Daten beim angegebenen Jahrgang gefunden, um einen Abiturjahrgang anzulegen * Code 409: Der Abiturjahrgang existiert bereits * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} schuljahresabschnittsid - der Pfad-Parameter schuljahresabschnittsid * @param {number} jahrgangid - der Pfad-Parameter jahrgangid * * @returns Der Abiturjahrgang wurde erfolgreich angelegt. */ createGostAbiturjahrgang(schema: string, schuljahresabschnittsid: number, jahrgangid: number): Promise; /** * Implementierung der GET-Methode restauriereGostBlockung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{abiturjahr : \d+}/{halbjahr : \d+}/restore * * Restauriert die Blockung aus den Leistungsdaten. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Restaurieren einer Blockung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Listeneintrag zu der restaurierten Blockung * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungListeneintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe zu restaurieren. * Code 404: Keine Daten für das Abiturjahr und das Halbjahr gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Der Listeneintrag zu der restaurierten Blockung */ restauriereGostBlockung(schema: string, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der POST-Methode revertActivateGostBlockungsergebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{abiturjahr : \d+}/{halbjahr : \d+}/revertactivate * * Macht das Aktivieren bzw. persistieren in den Leistungsdaten rückgängig. Dies ist nur erlaubt, wenn Kurse der gymnasialen Oberstufe vorhanden sind und bei den Leistungsdaten der Schüler des Abiturjahrgangs in dem Halbjahr der gymnasialen Oberstufe noch keine Noteneinträge für eine Quartalsnode oder Halbjahresnote vorliegen.Es wird auch geprüft, ob der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Blockungsdaten wurden bei den Kursen und Leistungsdaten erfolgreich gelöscht. * Code 400: Es existieren Schüler mit Noten in den Leistungsdaten. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Persistierung rückgängig zu machen. * Code 404: Es wurden keine Kurse der gymnasialen Oberstufe gefunden oder der Abiturjahrgang oder die ID des Halbjahres sind fehlerhaft. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr */ revertActivateGostBlockungsergebnis(schema: string, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+} * * Entfernt die angegebene Blockung der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Blockungsdaten der gymnasialen Oberstfue für die angegebene ID wurden erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: Long * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe zu löschen. * Code 404: Keine Blockung mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Blockungsdaten der gymnasialen Oberstfue für die angegebene ID wurden erfolgreich gelöscht. */ deleteGostBlockung(schema: string, blockungsid: number): Promise; /** * Implementierung der GET-Methode getGostBlockung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+} * * Liest für die angegebene Blockung der gymnasialen Oberstufe die grundlegenden Daten aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Blockungsdaten der gymnasialen Oberstfue für die angegebene ID * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe auszulesen. * Code 404: Keine Blockung mit der angebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Blockungsdaten der gymnasialen Oberstfue für die angegebene ID */ getGostBlockung(schema: string, blockungsid: number): Promise; /** * Implementierung der PATCH-Methode patchGostBlockung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+} * * Passt die Blockungsdaten der Gymnasiale Oberstufe mit der angegebenen ID an.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Blockungsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Blockungsdaten zu ändern. * Code 404: Kein Blockungsdaten-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid */ patchGostBlockung(data: Partial, schema: string, blockungsid: number): Promise; /** * Implementierung der POST-Methode addGostBlockungErgebnisse für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/addergebnisse * * Fügt mehrere Ergebnisse zu einer Blockung der Gymnasialen Oberstufe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen von Ergebnissen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Ergebnisse wurden erfolgreich der Blockung hinzugefügt * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 400: Die Daten sind nicht konsistent (z.B. bei einer nicht passenden Blockungs-ID in der Ergebnissen). * Code 403: Der SVWS-Benutzer hat keine Rechte, um Ergebnisse hinzuzufügen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Ergebnisse wurden erfolgreich der Blockung hinzugefügt */ addGostBlockungErgebnisse(data: List, schema: string, blockungsid: number): Promise>; /** * Implementierung der POST-Methode addGostBlockungRegel für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/addregel/{regeltyp : \d+} * * Fügt eine Regel zu einer Blockung der Gymnasialen Oberstufe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Regel hat. * * Mögliche HTTP-Antworten: * Code 200: Die Regel der Blockung der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungRegel * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Regel hinzuzufügen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * @param {number} regeltyp - der Pfad-Parameter regeltyp * * @returns Die Regel der Blockung der gymnasialen Oberstufe */ addGostBlockungRegel(data: List, schema: string, blockungsid: number, regeltyp: number): Promise; /** * Implementierung der POST-Methode addGostBlockungRegeln für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/addregeln * * Fügt mehrere Regeln zu einer Blockung der Gymnasialen Oberstufe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen von Regeln hat. * * Mögliche HTTP-Antworten: * Code 200: Die Regeln wurden erfolgreich der Blockung hinzugefügt * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Regeln hinzuzufügen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Regeln wurden erfolgreich der Blockung hinzugefügt */ addGostBlockungRegeln(data: List, schema: string, blockungsid: number): Promise>; /** * Implementierung der POST-Methode addGostBlockungSchiene für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/addschiene * * Fügt eine Schiene zu einer Blockung der Gymnasialen Oberstufe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Schiene hat. * * Mögliche HTTP-Antworten: * Code 200: Die Schiene der Blockung der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungSchiene * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Schiene hinzuzufügen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Schiene der Blockung der gymnasialen Oberstufe */ addGostBlockungSchiene(schema: string, blockungsid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungSchiene für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/deleteschiene * * Entfernt eine Schiene bei einer Blockung der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen einer Schiene hat. * * Mögliche HTTP-Antworten: * Code 200: Die Schiene wurde wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungSchiene * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Schiene zu entfernen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Schiene wurde wurde erfolgreich entfernt. */ deleteGostBlockungSchiene(schema: string, blockungsid: number): Promise; /** * Implementierung der POST-Methode addGostBlockungKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/fach/{fachid : \d+}/kursart/{kursartid : \d+}/add * * Fügt einen Kurs zu einer Blockung der Gymnasialen Oberstufe hinzu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Kurses hat. * * Mögliche HTTP-Antworten: * Code 200: Der Kurs der Blockung der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKurs * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Kurs hinzuzufügen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * @param {number} fachid - der Pfad-Parameter fachid * @param {number} kursartid - der Pfad-Parameter kursartid * * @returns Der Kurs der Blockung der gymnasialen Oberstufe */ addGostBlockungKurs(schema: string, blockungsid: number, fachid: number, kursartid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/fach/{fachid : \d+}/kursart/{kursartid : \d+}/delete * * Entfernt einen Kurs bei einer Blockung der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen eines Kurses hat. * * Mögliche HTTP-Antworten: * Code 200: Der Kurs wurde wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKurs * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Kurs zu entfernen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * @param {number} fachid - der Pfad-Parameter fachid * @param {number} kursartid - der Pfad-Parameter kursartid * * @returns Der Kurs wurde wurde erfolgreich entfernt. */ deleteGostBlockungKurs(schema: string, blockungsid: number, fachid: number, kursartid: number): Promise; /** * Implementierung der GET-Methode getGostBlockungGZip für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/gzip * * Liest für die angegebene Blockung der gymnasialen Oberstufe die grundlegenden Daten aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GZip-komprimierten Blockungsdaten der gymnasialen Oberstfue für die angegebene ID * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe auszulesen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 404: Keine Blockung mit der angebenen ID gefunden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 409: Die Daten der Blockung konnten nicht fehlerfrei bestimmt werden. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter interner Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die GZip-komprimierten Blockungsdaten der gymnasialen Oberstfue für die angegebene ID */ getGostBlockungGZip(schema: string, blockungsid: number): Promise; /** * Implementierung der POST-Methode rechneGostBlockung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/rechne/{zeit : \d+} * * Berechnet für die angegebene Blockung der gymnasialen Oberstufe Zwischenergebnisse und speichert diese in der DB. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Rechnen einer Blockung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der IDs der Zwischenergebnisse * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe auf dem Server zu rechnen. * Code 404: Keine Blockung mit der angegebenen ID gefunden. * Code 500: Ein unerwarteter Fehler ist beim Blocken aufgetreten. * - Mime-Type: text/plain * - Rückgabe-Typ: String * * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * @param {number} zeit - der Pfad-Parameter zeit * * @returns Eine Liste der IDs der Zwischenergebnisse */ rechneGostBlockung(schema: string, blockungsid: number, zeit: number): Promise>; /** * Implementierung der POST-Methode updateGostBlockungRegeln für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/{blockungsid : \d+}/regeln/update * * Entfernt und fügt mehrere Regeln einer Blockung der Gymnasialen Oberstufe hinzu. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen und Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Regeln wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Regeln * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Regeln zu löschen oder hinzufügen. * Code 404: Ein Wert für das Erstellen der Regeln wurde nicht gefunden. * * @param {GostBlockungRegelUpdate} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} blockungsid - der Pfad-Parameter blockungsid * * @returns Die Regeln wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Regeln */ updateGostBlockungRegeln(data: GostBlockungRegelUpdate, schema: string, blockungsid: number): Promise>; /** * Implementierung der GET-Methode getGostBlockungKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+} * * Liest den angegebenen Kurs einer Blockung der gymnasialen Oberstufe aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Kurs der Blockung der gymnasialen Oberstufe für die angegebene ID * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKurs * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe auszulesen. * Code 404: Kein Kurs einer Blockung mit der angebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * * @returns Der Kurs der Blockung der gymnasialen Oberstufe für die angegebene ID */ getGostBlockungKurs(schema: string, kursid: number): Promise; /** * Implementierung der PATCH-Methode patchGostBlockungKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+} * * Passt den angebenene Kurs der Gymnasiale Oberstufe mit der angegebenen ID an.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen von Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Blockungsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Blockungsdaten zu ändern. * Code 404: Kein Kurs einer Blockung mit der angegebenen ID gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid */ patchGostBlockungKurs(data: Partial, schema: string, kursid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungKursByID für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+} * * Entfernt einen Kurs einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Kurs wurde wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKurs * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Kurs zu löschen. * Code 404: Der Kurs wurde nicht bei einer Blockung gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * * @returns Der Kurs wurde wurde erfolgreich gelöscht. */ deleteGostBlockungKursByID(schema: string, kursid: number): Promise; /** * Implementierung der GET-Methode getGostBlockungKurslehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+}/lehrer/{lehrerid : \d+} * * Liest einen Kurs-Lehrer eines Kurses einer Blockung der Gymnasialen Oberstufe aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten zu dem Kurs-Lehrer. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKursLehrer * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kurslehrer auszulesen. * Code 404: Der Kurs wurde nicht bei einer Blockung gefunden oder der Lehrer mit der ID existiert nicht. * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * @param {number} lehrerid - der Pfad-Parameter lehrerid * * @returns Die Daten zu dem Kurs-Lehrer. */ getGostBlockungKurslehrer(schema: string, kursid: number, lehrerid: number): Promise; /** * Implementierung der PATCH-Methode patchGostBlockungKurslehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+}/lehrer/{lehrerid : \d+} * * Passt einen Kurs-Lehrer eines Kurses einer Blockung der Gymnasialen Oberstufe an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Daten wurden erfolgreich angepasst. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zum Kurslehrer anzupassen. * Code 404: Der Kurs wurde nicht bei einer Blockung gefunden oder der Lehrer mit der ID existiert nicht. * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * @param {number} lehrerid - der Pfad-Parameter lehrerid */ patchGostBlockungKurslehrer(data: Partial, schema: string, kursid: number, lehrerid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungKurslehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+}/lehrer/{lehrerid : \d+} * * Entfernt einen Kurs-Lehrer eines Kurses einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Daten wurden erfolgreich entfernt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kurslehrer zu entfernen. * Code 404: Der Kurs wurde nicht bei einer Blockung gefunden oder der Lehrer mit der ID existiert nicht bei dem Kurs. * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * @param {number} lehrerid - der Pfad-Parameter lehrerid */ deleteGostBlockungKurslehrer(schema: string, kursid: number, lehrerid: number): Promise; /** * Implementierung der POST-Methode addGostBlockungKurslehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+}/lehrer/{lehrerid : \d+}/add * * Fügt einen Kurs-Lehrer zu einem Kurs einer Blockung der Gymnasialen Oberstufe hinzu. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten zu dem hinzugefügten Kurs-Lehrer. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKursLehrer * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kurslehrer hinzuzufügen. * Code 404: Der Kurs wurde nicht bei einer Blockung gefunden oder der Lehrer mit der ID existiert nicht. * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * @param {number} lehrerid - der Pfad-Parameter lehrerid * * @returns Die Daten zu dem hinzugefügten Kurs-Lehrer. */ addGostBlockungKurslehrer(schema: string, kursid: number, lehrerid: number): Promise; /** * Implementierung der POST-Methode splitGostBlockungKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid : \d+}/split * * Teilt einen Kurs einer Blockung der Gymnasialen Oberstufe auf, indem ein zweiter Kurs mit der Hälfte der schüler erzeugt wird.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Teilen eines Kurses hat. * * Mögliche HTTP-Antworten: * Code 200: Der zusätzliche Kurs der Blockung der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKursAufteilung * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Kurs hinzuzufügen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid - der Pfad-Parameter kursid * * @returns Der zusätzliche Kurs der Blockung der gymnasialen Oberstufe */ splitGostBlockungKurs(schema: string, kursid: number): Promise; /** * Implementierung der POST-Methode combineGostBlockungKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/{kursid1 : \d+}/combine/{kursid2 : \d+} * * Führt zwei Kurse einer Blockung der Gymnasialen Oberstufe zusammen, sofern Fach und Kursart zusammenpassen.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Zusammenführen der Kurse hat. * * Mögliche HTTP-Antworten: * Code 200: Der zusammengeführte Kurs der Blockung der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungKurs * Code 403: Der SVWS-Benutzer hat keine Rechte, um zwei Kurse zusammenzuführen. * Code 404: Keine Blockung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} kursid1 - der Pfad-Parameter kursid1 * @param {number} kursid2 - der Pfad-Parameter kursid2 * * @returns Der zusammengeführte Kurs der Blockung der gymnasialen Oberstufe */ combineGostBlockungKurs(schema: string, kursid1: number, kursid2: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungKurse für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/kurse/delete/multiple * * Entfernt mehrere Kurse einer Blockung.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Kurse wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kurse zu löschen. * Code 404: Einer oder mehrere der Kurse sind nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Kurse wurde erfolgreich entfernt. */ deleteGostBlockungKurse(data: List, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteGostBlockungRegelnByID für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/regeln * * Entfernt mehrere Regeln einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Regeln wurde wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Regeln zu löschen. * Code 404: Mindestens eine Regel wurde nicht bei einer Blockung gefunden. * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ deleteGostBlockungRegelnByID(data: List, schema: string): Promise; /** * Implementierung der GET-Methode getGostBlockungRegel für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/regeln/{regelid : \d+} * * Liest die angegebene Regel einer Blockung der gymnasialen Oberstufe aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Regel der Blockung der gymnasialen Oberstufe für die angegebene ID * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungRegel * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe auszulesen. * Code 404: Keine Regel einer Blockung mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} regelid - der Pfad-Parameter regelid * * @returns Die Regel der Blockung der gymnasialen Oberstufe für die angegebene ID */ getGostBlockungRegel(schema: string, regelid: number): Promise; /** * Implementierung der PATCH-Methode patchGostBlockungRegel für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/regeln/{regelid : \d+} * * Passt die angegebene Regel der Gymnasiale Oberstufe mit der angegebenen ID an.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen von Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Blockungsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Blockungsdaten zu ändern. * Code 404: Keine Regel einer Blockung mit der angebenen ID gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} regelid - der Pfad-Parameter regelid */ patchGostBlockungRegel(data: Partial, schema: string, regelid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungRegelByID für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/regeln/{regelid : \d+} * * Entfernt eine Regel einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Regel wurde wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungRegel * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Regel zu löschen. * Code 404: Die Regel wurde nicht bei einer Blockung gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} regelid - der Pfad-Parameter regelid * * @returns Die Regel wurde wurde erfolgreich gelöscht. */ deleteGostBlockungRegelByID(schema: string, regelid: number): Promise; /** * Implementierung der GET-Methode getGostBlockungSchiene für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/schiene/{schienenid : \d+} * * Liest die angegebene Schiene einer Blockung der gymnasialen Oberstufe aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schiene der Blockung der gymnasialen Oberstfue für die angegebene ID * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungSchiene * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe auszulesen. * Code 404: Keine Schiene einer Blockung mit der angebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} schienenid - der Pfad-Parameter schienenid * * @returns Die Schiene der Blockung der gymnasialen Oberstfue für die angegebene ID */ getGostBlockungSchiene(schema: string, schienenid: number): Promise; /** * Implementierung der PATCH-Methode patchGostBlockungSchiene für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/schiene/{schienenid : \d+} * * Passt die angegebene Schiene der Gymnasiale Oberstufe mit der angegebenen ID an.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen von Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Blockungsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Blockungsdaten zu ändern. * Code 404: Keine Schiene einer Blockung mit der angegebenen ID gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schienenid - der Pfad-Parameter schienenid */ patchGostBlockungSchiene(data: Partial, schema: string, schienenid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungSchieneByID für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/schiene/{schienenid : \d+} * * Entfernt eine Schiene einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schiene wurde wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungSchiene * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schiene zu löschen. * Code 404: Die Schiene wurde nicht bei einer Blockung gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} schienenid - der Pfad-Parameter schienenid * * @returns Die Schiene wurde wurde erfolgreich gelöscht. */ deleteGostBlockungSchieneByID(schema: string, schienenid: number): Promise; /** * Implementierung der GET-Methode getGostBlockungsergebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+} * * Liest für das angegebene Blockungsergebnis einer Blockung der gymnasialen Oberstufe die Daten aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsergebnisse besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Blockungsergebnisse der gymnasialen Oberstufe für die angegebene ID * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungsergebnis * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsergebnisse einer Blockung der Gymnasialen Oberstufe auszulesen. * Code 404: Keine Blockung mit der angebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * * @returns Die Blockungsergebnisse der gymnasialen Oberstufe für die angegebene ID */ getGostBlockungsergebnis(schema: string, ergebnisid: number): Promise; /** * Implementierung der PATCH-Methode patchGostBlockungsergebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+} * * Passt die Daten eines Blockungsergebnisses der Gymnasiale Oberstufe mit der angegebenen ID an.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Blockungsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Blockungsdaten zu ändern. * Code 404: Kein Blockungsdaten-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid */ patchGostBlockungsergebnis(data: Partial, schema: string, ergebnisid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungsergebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+} * * Entfernt das angegebene Zwischenergebnis einer Blockung der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen des Zwischenergebnisses besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das Zwischenergebnis einer Blockung der gymnasialen Oberstufe für die angegebene ID wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: Long * Code 403: Der SVWS-Benutzer hat keine Rechte, um das Zwischenergebnis einer Blockung der Gymnasialen Oberstufe zu löschen. * Code 404: Keine Blockung mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * * @returns Das Zwischenergebnis einer Blockung der gymnasialen Oberstufe für die angegebene ID wurde erfolgreich gelöscht. */ deleteGostBlockungsergebnis(schema: string, ergebnisid: number): Promise; /** * Implementierung der POST-Methode activateGostBlockungsergebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/activate * * Aktiviert bzw. persistiert das Blockungsergebnis. Dies ist nur erlaubt, wenn keine aktivierte Blockung in der DB vorliegt. Beim Aktivieren wird die Kursliste und die Leistungsdaten der Schüler entsprechend befüllt.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Aktivieren eines Blockungsergebnisses besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um ein Blockungsergebnis zu aktivieren. * Code 404: Keine oder nicht alle Daten zu dem Ergebnis gefunden, um dieses zu aktiveren * Code 409: Es wurde bereits eine Blockung aktiviert * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid */ activateGostBlockungsergebnis(schema: string, ergebnisid: number): Promise; /** * Implementierung der GET-Methode dupliziereGostBlockungMitErgebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/dupliziere * * Dupliziert zu dem angegebenen Zwischenergebnis gehörende Blockung der gymnasialen Oberstufe. Das Zwischenergebnis wird als einziges mit dupliziert und dient bei dem Blockungsduplikat. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Duplizieren einer Blockung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Blockungslisteneintrag des Duplikats * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungListeneintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockungsdaten der Gymnasialen Oberstufe zu duplizieren. * Code 404: Kein Blockungsergebnis mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * * @returns Der Blockungslisteneintrag des Duplikats */ dupliziereGostBlockungMitErgebnis(schema: string, ergebnisid: number): Promise; /** * Implementierung der GET-Methode schreibeGostBlockungsErgebnisHoch für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/hochschreiben * * Schreibt die zum Ergebnis gehörende Blockung mit dem Ergebnis in das nächste Halbjahr hoch. Nicht mehr vorhandene Fachwahlen werden ggf. automatisch entfernt. Es werden aber keine neuen Kurse oder Zuordnung neu generiert. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hochschreiben einer Blockung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Blockung und das Ergebnis wurde erfolgreich hochgeschrieben. * - Mime-Type: application/json * - Rückgabe-Typ: GostBlockungsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Blockung der Gymnasialen Oberstufe hochzuschreiben. * Code 404: Kein Blockungsergebnis mit der angebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * * @returns Die Blockung und das Ergebnis wurde erfolgreich hochgeschrieben. */ schreibeGostBlockungsErgebnisHoch(schema: string, ergebnisid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungsergebnisKursSchieneZuordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/removeKursSchienenZuordnungen * * Entfernt mehrere Kurs-Schienen-Zuordnungen bei einem Blockungsergebniss einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnungen wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zuordnungen zu löschen. * Code 404: Das Zwischenergebnis, eine Schiene oder ein Kurs wurde nicht in einer gültigen Zuordnung gefunden. * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid */ deleteGostBlockungsergebnisKursSchieneZuordnungen(data: List, schema: string, ergebnisid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungsergebnisKursSchuelerZuordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/removeKursSchuelerZuordnungen * * Entfernt mehrere Kurs-Schüler-Zuordnungen bei einem Blockungsergebniss einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnungen wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zuordnungen zu löschen. * Code 404: Das Zwischenergebnis, ein Schüler oder ein Kurs wurde nicht in einer gültigen Zuordnung gefunden. * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid */ deleteGostBlockungsergebnisKursSchuelerZuordnungen(data: List, schema: string, ergebnisid: number): Promise; /** * Implementierung der POST-Methode createGostBlockungsergebnisKursSchieneZuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/schiene/{schienenid : \d+}/kurs/{kursid: \d+} * * Erstellt eine Kurszuordnung zu einer Schiene bei einem Blockungsergebnis einer Blockung der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen der Zuordnung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich angelegt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Zuordnung anzulegen. * Code 404: Kein geeignetes Zwischenergebnis, Schiene oder Kurs für die Zuordnung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * @param {number} schienenid - der Pfad-Parameter schienenid * @param {number} kursid - der Pfad-Parameter kursid */ createGostBlockungsergebnisKursSchieneZuordnung(schema: string, ergebnisid: number, schienenid: number, kursid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungsergebnisKursSchieneZuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/schiene/{schienenid : \d+}/kurs/{kursid: \d+} * * Entfernt eine Kurszuordnung zu einer Schiene bei einem Blockungsergebniss einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zuordnung zu löschen. * Code 404: Das Zwischenergebnis, der Schiene oder der Kurs wurde nicht in einer gültigen Zuordnung gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * @param {number} schienenid - der Pfad-Parameter schienenid * @param {number} kursid - der Pfad-Parameter kursid */ deleteGostBlockungsergebnisKursSchieneZuordnung(schema: string, ergebnisid: number, schienenid: number, kursid: number): Promise; /** * Implementierung der POST-Methode updateGostBlockungsergebnisKursSchieneZuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/schiene/{schienenid: \d+}/kurs/{kursid: \d+}/zu/{schienenidneu: \d+} * * Verschiebt einen Kurse zwischen zwei Schienen bei einem Blockungsergebnis einer Blockung der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Verschieben besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich angelegt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Kurs zu verschieben. * Code 404: Kein geeignetes Zwischenergebnis, Schiene oder Kurs für die Zuordnung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * @param {number} schienenid - der Pfad-Parameter schienenid * @param {number} kursid - der Pfad-Parameter kursid * @param {number} schienenidneu - der Pfad-Parameter schienenidneu */ updateGostBlockungsergebnisKursSchieneZuordnung(schema: string, ergebnisid: number, schienenid: number, kursid: number, schienenidneu: number): Promise; /** * Implementierung der POST-Methode createGostBlockungsergebnisKursSchuelerZuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/schueler/{schuelerid : \d+}/kurs/{kursid: \d+} * * Erstellt eine Kurszuordnung zu einem Schüler bei einem Blockungsergebnis einer Blockung der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen der Zuordnung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich angelegt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Zuordnung anzulegen. * Code 404: Kein geeignetes Zwischenergebnis, Schüler oder Kurs für die Zuordnung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * @param {number} schuelerid - der Pfad-Parameter schuelerid * @param {number} kursid - der Pfad-Parameter kursid */ createGostBlockungsergebnisKursSchuelerZuordnung(schema: string, ergebnisid: number, schuelerid: number, kursid: number): Promise; /** * Implementierung der DELETE-Methode deleteGostBlockungsergebnisKursSchuelerZuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/schueler/{schuelerid : \d+}/kurs/{kursid: \d+} * * Entfernt eine Kurszuordnung zu einem Schüler bei einem Blockungsergebniss einer Blockung der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zuordnung zu löschen. * Code 404: Das Zwischenergebnis, der Schüler oder der Kurs wurde nicht in einer gültigen Zuordnung gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * @param {number} schuelerid - der Pfad-Parameter schuelerid * @param {number} kursid - der Pfad-Parameter kursid */ deleteGostBlockungsergebnisKursSchuelerZuordnung(schema: string, ergebnisid: number, schuelerid: number, kursid: number): Promise; /** * Implementierung der POST-Methode updateGostBlockungsergebnisKursSchuelerZuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/schueler/{schuelerid : \d+}/kurs/{kursid: \d+}/zu/{kursidneu: \d+} * * Verschiebt einen Schüler zwischen zwei Kursen bei einem Blockungsergebnis einer Blockung der Gymnasialen Oberstufe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Verschieben besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich angelegt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um das Verschieben vorzunehmen. * Code 404: Kein geeignetes Zwischenergebnis, Schüler oder Kurs für die Zuordnung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * @param {number} schuelerid - der Pfad-Parameter schuelerid * @param {number} kursid - der Pfad-Parameter kursid * @param {number} kursidneu - der Pfad-Parameter kursidneu */ updateGostBlockungsergebnisKursSchuelerZuordnung(schema: string, ergebnisid: number, schuelerid: number, kursid: number, kursidneu: number): Promise; /** * Implementierung der POST-Methode syncGostBlockungsergebnis für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/synchronize * * Synchronisiert das Blockungsergebnis mit den Kursen und den Leistungsdaten. Dies ist nur erlaubt, wenn Leistungsdatenin der DB vorliegen. Beim Synchronisieren werden die Kursliste und die Leistungsdaten der Schüler angepasst. Es werden jedoch keine Kurse entfernt und es werden keine Fachwahlen bei Schülern ergänzt.Dies muss ggf. manuell erfolgen.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Aktivieren eines Blockungsergebnisses besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Zuordnung wurde erfolgreich synchronisiert. * Code 400: Das Ergebnis ist einem vergangenem Schuljahresabschnitt zugeordnet. Eine Synchronisation wird hier nicht mehr zugelassen. * Code 403: Der SVWS-Benutzer hat keine Rechte, um ein Blockungsergebnis mit den Leristungsdaten zu synchronisieren. * Code 404: Keine oder nicht alle Daten zu dem Ergebnis gefunden, um dieses zu synchronisieren * Code 409: Es sind noch keinerlei Leistungsdaten für eine Synchronisation in dem Schuljahresabschnitt bei den Schülern vorhanden. Verwenden Sie stattdessen das Aktivieren eines Ergebnisses. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid */ syncGostBlockungsergebnis(schema: string, ergebnisid: number): Promise; /** * Implementierung der POST-Methode updateGostBlockungsergebnisKursSchuelerZuordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/{ergebnisid : \d+}/updateKursSchuelerZuordnungen * * Entfernt und fügt mehrere Kurs-Schüler-Zuordnungen bei einem Blockungsergebniss einer Blockung der Gymnasialen Oberstufe hinzu. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen und Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Zuordnungen wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Regeln, falls Regeln angepasst wurden, oder eine leere Liste, falls keine angepasst wurden. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zuordnungen zu löschen oder hinzufügen. * Code 404: Das Zwischenergebnis, ein Schüler oder ein Kurs wurde nicht in einer gültigen Zuordnung gefunden. * * @param {GostBlockungsergebnisKursSchuelerZuordnungUpdate} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} ergebnisid - der Pfad-Parameter ergebnisid * * @returns Die Zuordnungen wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Regeln, falls Regeln angepasst wurden, oder eine leere Liste, falls keine angepasst wurden. */ updateGostBlockungsergebnisKursSchuelerZuordnungen(data: GostBlockungsergebnisKursSchuelerZuordnungUpdate, schema: string, ergebnisid: number): Promise>; /** * Implementierung der DELETE-Methode deleteGostBlockungsergebnisse für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/blockungen/zwischenergebnisse/multiple * * Entfernt die angegebenen Zwischenergebnisse einer Blockung der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen der Zwischenergebnisse besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Zwischenergebnisse einer Blockung der gymnasialen Oberstufe für die angegebene ID wurden erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: Long * Code 400: Die Ergebnisse gehören nicht zu einer Blockung. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zwischenergebnisse einer Blockung der Gymnasialen Oberstufe zu löschen. * Code 404: Mindestens ein Ergebnis wurde nicht gefunden. * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Zwischenergebnisse einer Blockung der gymnasialen Oberstufe für die angegebene ID wurden erfolgreich gelöscht. */ deleteGostBlockungsergebnisse(data: List, schema: string): Promise; /** * Implementierung der PATCH-Methode patchGostFachkombination für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/fachkombination/{id : \d+} * * Passt die Fachkombination mit der angegebenen ID an.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen von Fachkombinationen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Fachkombination integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachkombinationen zu ändern. * Code 404: Keine Fachkombination mit der angegebenen ID gefunden oder es wurden kein gültiges Fach als ID übergeben. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchGostFachkombination(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteGostFachkombination für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/fachkombination/{id : \d+} * * Entfernt eine Regel zu einer Fachkombination in der Gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Regel wurde wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: GostJahrgangFachkombination * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Regel zu der Fachkombination zu löschen. * Code 404: Die Regel zu der Fachkombination wurde nicht gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Regel wurde wurde erfolgreich gelöscht. */ deleteGostFachkombination(schema: string, id: number): Promise; /** * Implementierung der POST-Methode getGostKlausurenCollectionAlldata für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/collections/alldata * * Liefert alle zur Klausurplanung gehörenden Daten in einem GostKlausurenCollectionAllData-Objekt.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das GostKlausurenCollectionAllData-Objekt mit den Daten der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionAllData * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten auszulesen. * Code 404: Der Abiturjahrgang oder das GostHalbjahr wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Das GostKlausurenCollectionAllData-Objekt mit den Daten der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. */ getGostKlausurenCollectionAlldata(data: List, schema: string): Promise; /** * Implementierung der POST-Methode getGostKlausurenCollectionAlldataGZip für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/collections/alldata/gzip * * Liefert alle zur Klausurplanung gehörenden Daten in einem komprimierten GostKlausurenCollectionAllData-Objekt. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GZip-komprimierten Daten der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Klausurplanung der Gymnasialen Oberstufe auszulesen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter interner Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die GZip-komprimierten Daten der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. */ getGostKlausurenCollectionAlldataGZip(data: List, schema: string): Promise; /** * Implementierung der GET-Methode getGostKlausurenCollectionAllIssues für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/collections/issues/abiturjahrgang/{abiturjahr : -?\d+}/halbjahr/{halbjahr : \d+} * * Liefert alle zur Klausurplanung gehörenden Fehler und Probleme in einem GostKlausurenCollectionHjData-Objekt.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das GostKlausurenCollectionAllData-Objekt mit den Fehlern und Problemen der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionHjData * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten auszulesen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Das GostKlausurenCollectionAllData-Objekt mit den Fehlern und Problemen der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. */ getGostKlausurenCollectionAllIssues(schema: string, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der GET-Methode getGostKlausurenCollectionAllIssuesGZip für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/collections/issues/abiturjahrgang/{abiturjahr : -?\d+}/halbjahr/{halbjahr : \d+}/gzip * * Liefert alle zur Klausurplanung gehörenden Fehler und Probleme in einem komprimierten GostKlausurenCollectionHjData-Objekt.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Blockungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das komprimierte GostKlausurenCollectionHjData-Objekt mit den Fehlern und Problemen der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Klausurdaten der Gymnasialen Oberstufe auszulesen. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 500: Es ist ein unerwarteter interner Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Das komprimierte GostKlausurenCollectionHjData-Objekt mit den Fehlern und Problemen der Klausurplanung für den angegebenen Abiturjahrgang und das Halbjahr. */ getGostKlausurenCollectionAllIssuesGZip(schema: string, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der POST-Methode patchGostKlausurenKursklausur für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/kursklausuren/{id : \d+} * * Patcht eine Gost-Kursklausur und gibt die daraufhin geänderten Raumdaten zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen einer Gost-Kursklausur besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Patch wurde erfolgreich in die Kursklausur integriert. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionSkrsKrsData * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kursklausuren zu ändern. * Code 404: Kein Kursklausur-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Patch wurde erfolgreich in die Kursklausur integriert. */ patchGostKlausurenKursklausur(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode blockenGostKursklausuren für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/kursklausuren/blocken * * Startet den Kursklausur-Blockungsalgorithmus für die übergebenen GostKlausurterminblockungDaten.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Blocken besitzt. * * Mögliche HTTP-Antworten: * Code 200: Klausurblockung wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionData * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Klausurblockung durchzuführen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {GostKlausurterminblockungDaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Klausurblockung wurde erfolgreich angelegt. */ blockenGostKursklausuren(data: GostKlausurterminblockungDaten, schema: string): Promise; /** * Implementierung der GET-Methode createGostKlausurenKursklausurenJahrgangHalbjahrQuartal für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/kursklausuren/create/abiturjahrgang/{abiturjahr : -?\d+}/halbjahr/{halbjahr : \d+}/quartal/{quartal : \d+} * * Erzeugt die Kursklausuren eines Abiturjahrgangs in einem bestimmten GostHalbjahr und Quartal der Gymnasialen Oberstufe. Schülerklausuren und Haupttermin-Schülerklausurtermine werden ebenfalls erzeugt.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen der Kursklausuren besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der Kursklausuren. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionData * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kursklausuren auszulesen. * Code 404: Keine Klausurvorgaben definiert oder der Schuljahresabschnitt wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * @param {number} quartal - der Pfad-Parameter quartal * * @returns Die Liste der Kursklausuren. */ createGostKlausurenKursklausurenJahrgangHalbjahrQuartal(schema: string, abiturjahr: number, halbjahr: number, quartal: number): Promise; /** * Implementierung der DELETE-Methode deleteGostKlausurenKursklausuren für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/kursklausuren/delete/multiple * * Löscht mehrere GostKursklausuren.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen einer GostKursklausur besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Kursklausuren für die angegebenen IDs wurden erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine GostKursklausur zu löschen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Kursklausuren für die angegebenen IDs wurden erfolgreich gelöscht. */ deleteGostKlausurenKursklausuren(data: List, schema: string): Promise>; /** * Implementierung der PATCH-Methode patchGostKlausurenRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/raeume/{id : \d+} * * Patcht einen GostKlausurraum.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen eines GostKlausurraums besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in den GostKlausurraum integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um GostKlausurräume zu ändern. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchGostKlausurenRaum(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode createGostKlausurenRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/raeume/create * * Erstellt einen neue GostKlausurraum und gibt ihn zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines GostKlausurraums besitzt. * * Mögliche HTTP-Antworten: * Code 201: GostKlausurraum wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurraum * Code 400: Die Daten sind fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen GostKlausurraum anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns GostKlausurraum wurde erfolgreich angelegt. */ createGostKlausurenRaum(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteGostKlausurenRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/raeume/delete/{id : \d+} * * Löscht einen Gost-Klausurraum.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen eines Gost-Klausurraums besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Klausurraum für die angegebene ID wurden erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: Boolean * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Gost-Klausurraum zu löschen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Klausurraum für die angegebene ID wurden erfolgreich gelöscht. */ deleteGostKlausurenRaum(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGostKlausurenCollectionBySchuelerid für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schueler/{sid : -?\d+}/abiturjahrgang/{abiturjahr : -?\d+}/halbjahr/{halbjahr : \d+} * * Fragt die Klausurdaten eines Schülers ab.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Abfrage war erfolgreich. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionData * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten auszulesen. * Code 404: Der Schüler-ID wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} sid - der Pfad-Parameter sid * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * * @returns Abfrage war erfolgreich. */ getGostKlausurenCollectionBySchuelerid(schema: string, sid: number, abiturjahr: number, halbjahr: number): Promise; /** * Implementierung der PATCH-Methode patchGostKlausurenSchuelerklausur für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/{id : \d+} * * Patcht eine Gost-Schuelerklausur.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen einer Gost-Schuelerklausur besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Schuelerklausur integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuelerklausuren zu ändern. * Code 404: Kein Schuelerklausur-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchGostKlausurenSchuelerklausur(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode createGostKlausurenSchuelerklausuren für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/create/multiple * * Erstellt mehrere neue GostSchuelerklausuren inklusive der zugehörigen GostSchuelerklausurTermine.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen der Daten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Daten wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionData * Code 400: Die Daten sind fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um GostSchuelerklausuren anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Daten wurde erfolgreich angelegt. */ createGostKlausurenSchuelerklausuren(data: List>, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteGostKlausurenSchuelerklausuren für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/delete/multiple * * Löscht mehrere GostSchuelerklausuren.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen einer GostSchuelerklausur besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schülerklausuren für die angegebenen IDs wurden erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine GostSchuelerklausur zu löschen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Schülerklausuren für die angegebenen IDs wurden erfolgreich gelöscht. */ deleteGostKlausurenSchuelerklausuren(data: List, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteGostKlausurenSchuelerklausurtermin für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/termine/{id : \d+} * * Löscht einen GostSchuelerklausurTermin.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen eines GostSchuelerklausurTermins besitzt. * * Mögliche HTTP-Antworten: * Code 200: GostSchuelerklausurTermin wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: Boolean * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen GostSchuelerklausurTermin zu löschen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns GostSchuelerklausurTermin wurde erfolgreich gelöscht. */ deleteGostKlausurenSchuelerklausurtermin(schema: string, id: number): Promise; /** * Implementierung der POST-Methode patchGostKlausurenSchuelerklausurtermin für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/termine/{id : \d+} * * Patcht einen GostSchuelerklausurTermin.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen eines GostSchuelerklausurTermin besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Patch wurde erfolgreich in den GostKlausurtermin integriert. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionSkrsKrsData * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um GostSchuelerklausurTermine zu ändern. * Code 404: Kein GostSchuelerklausurTermin-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Patch wurde erfolgreich in den GostKlausurtermin integriert. */ patchGostKlausurenSchuelerklausurtermin(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode blockenGostSchuelerklausurtermine für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/termine/blocken * * Startet den Nachschreiber-Blockungsalgorithmus für die übergebenen GostNachschreibterminblockungKonfiguration.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Blocken besitzt. * * Mögliche HTTP-Antworten: * Code 200: Klausurblockung wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionData * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Klausurblockung durchzuführen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {GostNachschreibterminblockungKonfiguration} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Klausurblockung wurde erfolgreich angelegt. */ blockenGostSchuelerklausurtermine(data: GostNachschreibterminblockungKonfiguration, schema: string): Promise; /** * Implementierung der POST-Methode createGostKlausurenSchuelerklausurtermin für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/termine/create * * Erstellt einen neuen GostSchuelerklausurTermin.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines GostSchuelerklausurTermins besitzt. * * Mögliche HTTP-Antworten: * Code 201: GostSchuelerklausurTermin wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostSchuelerklausurTermin * Code 400: Die Daten sind fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen GostSchuelerklausurTermin anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns GostSchuelerklausurTermin wurde erfolgreich angelegt. */ createGostKlausurenSchuelerklausurtermin(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode loescheGostSchuelerklausurtermineAusRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/termine/loescheraum * * Löscht die Raumzuweisungen für alle in den GostKlausurraumRich-Objekten übergebene GostSchuelerklausurTermin-IDsDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen einer Raumzuweisung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Raumzuweisungen wurde erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionSkrsKrsData * Code 403: Der SVWS-Benutzer hat keine Rechte, um Raumzuweisungen zu löschen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Raumzuweisungen wurde erfolgreich gelöscht. */ loescheGostSchuelerklausurtermineAusRaum(data: List, schema: string): Promise; /** * Implementierung der POST-Methode setzeGostSchuelerklausurtermineZuRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/schuelerklausuren/termine/zuraum * * Weist die in den GostKlausurraumRich-Objekten übergebenen IDs der GostSchuelerklausurTermine dem jeweiligen GostKlausurraum zu.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Zuweisen eines Klausurraums besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Raumzuweisungen wurden erfolgreich übernommen. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionSkrsKrsData * Code 403: Der SVWS-Benutzer hat keine Rechte, um Räume zuzuweisen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Raumzuweisungen wurden erfolgreich übernommen. */ setzeGostSchuelerklausurtermineZuRaum(data: List, schema: string): Promise; /** * Implementierung der POST-Methode patchGostKlausurenKlausurtermin für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/termine/{id : \d+} * * Patcht einen GostKlausurtermin.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen eines GostKlausurtermins besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Patch wurde erfolgreich in den GostKlausurtermin integriert. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurenCollectionSkrsKrsData * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um GostKlausurtermine zu ändern. * Code 404: Kein Kursklausur-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Patch wurde erfolgreich in den GostKlausurtermin integriert. */ patchGostKlausurenKlausurtermin(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode createGostKlausurenKlausurtermin für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/termine/create * * Erstellt einen neuen Gost-Klausurtermin und gibt ihn zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Gost-Klausurtermins besitzt. * * Mögliche HTTP-Antworten: * Code 201: Gost-Klausurtermin wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurtermin * Code 400: Die Daten sind fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Gost-Klausurtermin anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Gost-Klausurtermin wurde erfolgreich angelegt. */ createGostKlausurenKlausurtermin(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteGostKlausurenKlausurtermine für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/termine/delete/multiple * * Löscht mehrere GostKlausurtermine.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen eines GostKlausurtermins besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Klausurtermine für die angegebenen IDs wurden erfolgreich gelöscht. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen GostKlausurtermin zu löschen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Klausurtermine für die angegebenen IDs wurden erfolgreich gelöscht. */ deleteGostKlausurenKlausurtermine(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode updateGostKlausuren für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/update * * Patcht einen Gost-Klausurtermin.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen eines Gost-Klausurtermins besitzt. * * Mögliche HTTP-Antworten: * Code 200: Gost-Klausurraumstunde wurde erfolgreich angelegt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einer Gost-Klausurraumstunde anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {GostKlausurenUpdate} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ updateGostKlausuren(data: GostKlausurenUpdate, schema: string): Promise; /** * Implementierung der PATCH-Methode patchGostKlausurenVorgabe für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/vorgaben/{id : \d+} * * Patcht eine Gost-Klausurvorgabe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Patchen eines Gost-Klausurtermins besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Klausurvorgabe integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Klausurvorgaben zu ändern. * Code 404: Kein Klausurvorgabe-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchGostKlausurenVorgabe(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteGostKlausurenVorgabe für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/vorgaben/{id : \d+} * * Löscht eine Gost-Klausurvorgabe.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen einer Gost-Klausurvorgabe besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Klausurvorgabe für die angegebene ID wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Gost-Klausurvorgabe zu löschen. * Code 404: Die Gost-Klausurvorgabe wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ deleteGostKlausurenVorgabe(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGostKlausurenVorgabenJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/vorgaben/abiturjahrgang/{abiturjahr : -?\d+} * * Liefert die Klausurvorgaben eines Abiturjahrgangs der gymnasialen Oberstufe. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der Klausurvorgaben. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 400: Die Daten sind fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Klausurvorgaben auszulesen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * * @returns Die Liste der Klausurvorgaben. */ getGostKlausurenVorgabenJahrgang(schema: string, abiturjahr: number): Promise>; /** * Implementierung der POST-Methode createGostKlausurenVorgabe für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/vorgaben/create * * Erstellt eine neue Gost-Klausurvorgabe und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Gost-Klausurvorgabe besitzt. * * Mögliche HTTP-Antworten: * Code 201: Gost-Klausurvorgabe wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: GostKlausurvorgabe * Code 400: Die Daten sind fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Gost-Klausurvorgabe anzulegen. * Code 409: Die Gost-Klausurvorgabe ist schon in der Datenbank enthalten. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Gost-Klausurvorgabe wurde erfolgreich angelegt. */ createGostKlausurenVorgabe(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode copyGostKlausurenVorgaben für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/vorgaben/vorlagen/copyto/abiturjahrgang/{abiturjahr : -?\d+}/halbjahr/{halbjahr : -?\d+}/quartal/{quartal : -?\d+} * * Kopiert die Klausurvorgabe-Vorlagen in einen konkreten Abiturjahrgang und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anlegen der Gost-Klausurvorgaben besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der neuen Klausurvorgaben. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 400: Falsche Parameter * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Gost-Klausurvorgabe anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} abiturjahr - der Pfad-Parameter abiturjahr * @param {number} halbjahr - der Pfad-Parameter halbjahr * @param {number} quartal - der Pfad-Parameter quartal * * @returns Die Liste der neuen Klausurvorgaben. */ copyGostKlausurenVorgaben(schema: string, abiturjahr: number, halbjahr: number, quartal: number): Promise>; /** * Implementierung der GET-Methode createGostKlausurenDefaultVorgaben für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/klausuren/vorgaben/vorlagen/create/halbjahr/{halbjahr : -?\d+}/quartal/{quartal : -?\d+} * * Legt die Default-Klausurvorgaben im Vorlagen-Jahrgang an und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Gost-Klausurvorgabe besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Liste der neuen Klausurvorgaben. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 400: Falsche Parameter * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Gost-Klausurvorgabe anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} halbjahr - der Pfad-Parameter halbjahr * @param {number} quartal - der Pfad-Parameter quartal * * @returns Die Liste der neuen Klausurvorgaben. */ createGostKlausurenDefaultVorgaben(schema: string, halbjahr: number, quartal: number): Promise>; /** * Implementierung der POST-Methode exportGostSchuelerLaufbahnplanungen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/laufbahnplanung/export * * Liest die Laufbahnplanungsdaten der gymnasialen Oberstufe für die angegebenen Schüler aus der Datenbank und liefert diese GZip-komprimiert zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GZip-komprimierten Laufbahndaten der gymnasialen Obertufe * - Mime-Type: application/zip * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Laufbahndaten auszulesen. * Code 404: Es wurden nicht alle benötigten Daten für das Erstellen der Laufbahn-Daten gefunden. * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die GZip-komprimierten Laufbahndaten der gymnasialen Obertufe */ exportGostSchuelerLaufbahnplanungen(data: List, schema: string): Promise; /** * Implementierung der POST-Methode importGostSchuelerLaufbahnplanungen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/laufbahnplanung/import * * Importiert die Laufbahndaten aus den übergebenen Laufbahnplanungsdatein * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Laufbahndaten * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Laufbahndaten zu importieren. * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Import der Laufbahndaten */ importGostSchuelerLaufbahnplanungen(data: FormData, schema: string): Promise; /** * Implementierung der GET-Methode getGostSchuelerAbiturdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/abiturdaten * * Liest die Abiturdaten aus den Abiturtabellen des Schülers mit der angegebene ID und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Abiturdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: Abiturdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leistungsdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * - Mime-Type: text/plain * - Rückgabe-Typ: String * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Abiturdaten des Schülers */ getGostSchuelerAbiturdaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchGostSchuelerAbiturdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/abiturdaten * * Passt die Abiturdaten eines Schüler an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Anpassungen durchzuführen. * Code 404: Keine passenden Daten für den Patch gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchGostSchuelerAbiturdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode copyGostSchuelerAbiturdatenAusLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/abiturdaten/uebertragen * * Überträgt die Abitur-relevanten Daten aus den Leistungsdaten in den Abiturbereich.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 204: Die Abiturdaten wurden erfolgreich übertragen * Code 400: Der Schüler hat aktuell nicht alle Leistungen für die Qualifikationsphase * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leistungsdaten in den Abiturbereich zu übertragen * Code 404: Es wurden keine Leistungsdaten für die Übertragung gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ copyGostSchuelerAbiturdatenAusLeistungsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGostSchuelerLaufbahnplanung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/laufbahnplanung * * Liest die Laufbahnplanungsdaten für die gymnasiale Oberstufe zu dem Schüler mit der angegebenen ID aus der Datenbank aus und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Laufbahnplanungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Laufbahnplanungsdaten der gymnasialen Oberstufe des angegebenen Schülers * - Mime-Type: application/json * - Rückgabe-Typ: Abiturdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Laufbahnplanungsdaten der Gymnasialen Oberstufe eines Schülers auszulesen. * Code 404: Kein Eintrag für einen Schüler mit Laufbahnplanungsdaten der gymnasialen Oberstufe für die angegebene ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Laufbahnplanungsdaten der gymnasialen Oberstufe des angegebenen Schülers */ getGostSchuelerLaufbahnplanung(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGostSchuelerLaufbahnplanungBeratungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/laufbahnplanung/beratungsdaten * * Liest die Beratungsdaten für die Laufbahnplanung der gymnasiale Oberstufe zu dem Schüler mit der angegebenen ID aus der Datenbank aus und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Beratungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Beratungsdaten der gymnasialen Oberstufe des angegebenen Schülers * - Mime-Type: application/json * - Rückgabe-Typ: GostLaufbahnplanungBeratungsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Beratungsdaten der Gymnasialen Oberstufe eines Schülers auszulesen. * Code 404: Kein Eintrag für einen Schüler mit Beratungsdaten der gymnasialen Oberstufe für die angegebene ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Beratungsdaten der gymnasialen Oberstufe des angegebenen Schülers */ getGostSchuelerLaufbahnplanungBeratungsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode exportGostSchuelerLaufbahnplanungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/laufbahnplanung/daten * * Liest die Laufbahnplanungsdaten der gymnasialen Oberstufe für den angegebenen Schüler aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Laufbahndaten der gymnasialen Oberstufe * - Mime-Type: application/json * - Rückgabe-Typ: GostLaufbahnplanungDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Laufbahndaten auszulesen. * Code 404: Es wurden nicht alle benötigten Daten für das Erstellen der Laufbahn-Daten gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Laufbahndaten der gymnasialen Oberstufe */ exportGostSchuelerLaufbahnplanungsdaten(schema: string, id: number): Promise; /** * Implementierung der POST-Methode importGostSchuelerLaufbahnplanungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/laufbahnplanung/daten * * Importiert die Laufbahndaten aus den übergebenen Laufbahnplanungsdaten * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Laufbahndaten * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Laufbahndaten zu importieren. * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {GostLaufbahnplanungDaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Log vom Import der Laufbahndaten */ importGostSchuelerLaufbahnplanungsdaten(data: GostLaufbahnplanungDaten, schema: string, id: number): Promise; /** * Implementierung der GET-Methode exportGostSchuelerLaufbahnplanung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/laufbahnplanung/export * * Liest die Laufbahnplanungsdaten der gymnasialen Oberstufe für den angegebenen Schüler aus der Datenbank und liefert diese GZip-komprimiert zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GZip-komprimierten Laufbahndaten der gymnasialen Obertufe * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Laufbahndaten auszulesen. * Code 404: Es wurden nicht alle benötigten Daten für das Erstellen der Laufbahn-Daten gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die GZip-komprimierten Laufbahndaten der gymnasialen Obertufe */ exportGostSchuelerLaufbahnplanung(schema: string, id: number): Promise; /** * Implementierung der POST-Methode importGostSchuelerLaufbahnplanung für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/laufbahnplanung/import * * Importiert die Laufbahndaten aus der übergebenen Laufbahnplanungsdatei * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Import der Laufbahndaten * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der Benutzer hat keine Berechtigung, um die Laufbahndaten zu importieren. * Code 409: Es ist ein Fehler beim Import aufgetreten. Ein Log vom Import wird zurückgegeben. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Log vom Import der Laufbahndaten */ importGostSchuelerLaufbahnplanung(data: FormData, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGostSchuelerLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{id : \d+}/leistungsdaten * * Liest die Leistungsdaten in Bezug auf die gymnasiale Oberstufe des Schülers mit der angegebene ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: GostLeistungen * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leistungsdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leistungsdaten des Schülers */ getGostSchuelerLeistungsdaten(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getGostSchuelerFachwahl für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{schuelerid : \d+}/fachwahl/{fachid : \d+} * * Liest für die gymnasiale Oberstufe die Fachwahlen zu einem Fach von dem angegebenen Schüler aus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Auslesen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Fachwahlen der gymnasialen Oberstufe für das angegebene Fach und den angegebenen Schüler * - Mime-Type: application/json * - Rückgabe-Typ: GostSchuelerFachwahl * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen der Gymnasialen Oberstufe eines Schülers auszulesen. * Code 404: Kein Eintrag für einen Schüler mit Laufbahnplanungsdaten der gymnasialen Oberstufe für die angegebene ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} schuelerid - der Pfad-Parameter schuelerid * @param {number} fachid - der Pfad-Parameter fachid * * @returns Die Fachwahlen der gymnasialen Oberstufe für das angegebene Fach und den angegebenen Schüler */ getGostSchuelerFachwahl(schema: string, schuelerid: number, fachid: number): Promise; /** * Implementierung der PATCH-Methode patchGostSchuelerFachwahl für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{schuelerid : \d+}/fachwahl/{fachid : \d+} * * Passt die Fachwahl eines Schüler in Bezug auf ein Fach der Gymnasiale Oberstufe an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Fachwahlen integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fachwahlen zu ändern. * Code 404: Kein Schüler- oder Fach-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schuelerid - der Pfad-Parameter schuelerid * @param {number} fachid - der Pfad-Parameter fachid */ patchGostSchuelerFachwahl(data: Partial, schema: string, schuelerid: number, fachid: number): Promise; /** * Implementierung der POST-Methode deleteGostSchuelerFachwahlen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{schuelerid : \d+}/fachwahl/delete * * Löscht die Fachwahlen des Schülers mit der angegebenen ID.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 203: Die Fachwahlen wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen zu löschen. * Code 404: Der Schüler bzw. der zugehörige Abiturjahrgang wurde nicht gefunden. * Code 409: Es liegen bereits bewertete Abschnitt vor, so dass die Fachwahlen nicht vollständig entfernt werden können. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} schuelerid - der Pfad-Parameter schuelerid */ deleteGostSchuelerFachwahlen(schema: string, schuelerid: number): Promise; /** * Implementierung der POST-Methode resetGostSchuelerFachwahlen für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{schuelerid : \d+}/fachwahl/reset * * Setzt die Fachwahlen des Schülers mit der angegebenen ID zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Zurücksetzen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 203: Die Fachwahlen wurden erfolgreich zurückgesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen zurückzusetzen. * Code 404: Der Schüler bzw. der zugehörige Abiturjahrgang wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} schuelerid - der Pfad-Parameter schuelerid */ resetGostSchuelerFachwahlen(schema: string, schuelerid: number): Promise; /** * Implementierung der PATCH-Methode patchGostSchuelerLaufbahnplanungBeratungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/{schuelerid : \d+}/laufbahnplanung/beratungsdaten * * Passt die Beratungsdaten für die Laufbahnplanung der gymnasiale Oberstufe zu dem Schüler mit der angegebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen der Beratungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Beratungsdaten zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schuelerid - der Pfad-Parameter schuelerid */ patchGostSchuelerLaufbahnplanungBeratungsdaten(data: Partial, schema: string, schuelerid: number): Promise; /** * Implementierung der POST-Methode deleteGostSchuelerFachwahlenMultiple für den Zugriff auf die URL https://{hostname}/db/{schema}/gost/schueler/fachwahlen/deleteMultiple * * Löscht die Fachwahlen der Schüler mit den angegebenen IDs.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen der Fachwahlen besitzt. * * Mögliche HTTP-Antworten: * Code 203: Die Fachwahlen wurden erfolgreich gelöscht. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Fachwahlen zu löschen. * Code 404: Ein Schüler bzw. der zugehörige Abiturjahrgang wurde nicht gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ deleteGostSchuelerFachwahlenMultiple(data: List, schema: string): Promise; /** * Implementierung der GET-Methode getHaltestellen für den Zugriff auf die URL https://{hostname}/db/{schema}/haltestellen * * Gibt die Haltestellen zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Haltestellen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Haltestellen. */ getHaltestellen(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchHaltestelle für den Zugriff auf die URL https://{hostname}/db/{schema}/haltestellen/{id : \d+} * * Patched die Haltestelle mit der angegebenen ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchHaltestelle(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addHaltestelle für den Zugriff auf die URL https://{hostname}/db/{schema}/haltestellen/create * * Erstellt eine neue Haltestelle, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Die Haltestelle wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Haltestelle * Code 403: Der SVWS-Benutzer hat keine Rechte, um Haltestellen anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Haltestelle wurde erfolgreich hinzugefügt. */ addHaltestelle(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteHaltestellen für den Zugriff auf die URL https://{hostname}/db/{schema}/haltestellen/delete/multiple * * Entfernt mehrere Haltestellen, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Haltestellen zu entfernen. * Code 404: Haltestellen nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteHaltestellen(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode importSQLite für den Zugriff auf die URL https://{hostname}/db/{schema}/import/sqlite * * Importiert die übergebene Datenbank in dieses Schema. Das Schema wird dabei zunächst geleert und vorhanden Daten gehen dabei verloren. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Importieren der SQLite-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: In das Schema darf nicht importiert werden. * Code 500: Fehler beim Importieren mit dem Log des fehlgeschlagenen Imports. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Importieren der SQLite-Datenbank */ importSQLite(data: FormData, schema: string): Promise; /** * Implementierung der GET-Methode getJahrgaenge für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/ * * Erstellt eine Liste aller in der Datenbank vorhanden Jahrgänge unter Angabe der ID, des Kürzels, des verwendeten Statistik-Kürzels, der Bezeichnung des Jahrgangs, die Schulgliederung zu der der Jahrgang gehört, die ID eines Folgejahrgangs, sofern definiert, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Jahrgangsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Jahrgangs-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Jahrgangsdaten anzusehen. * Code 404: Keine Jahrgangs-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Jahrgangs-Listen-Einträgen */ getJahrgaenge(schema: string): Promise>; /** * Implementierung der GET-Methode getJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/{id : \d+} * * Liest die Daten des Jahrgangs zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Jahrgangsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Jahrgangs * - Mime-Type: application/json * - Rückgabe-Typ: JahrgangsDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Jahrgangsdaten anzusehen. * Code 404: Kein Jahrgangs-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Jahrgangs */ getJahrgang(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/{id : \d+} * * Passt den Jahrgang mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Jahrgangsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchJahrgang(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/{id : \d+} * * Entfernt einen Jahrgang. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Jahrgänge hat. * * Mögliche HTTP-Antworten: * Code 200: Der Jahrgang wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: JahrgangsDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Jahrgang zu bearbeiten. * Code 404: Kein Jahrgang vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Jahrgang wurde erfolgreich entfernt. */ deleteJahrgang(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogJahrgaenge für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/allgemein/jahrgaenge * * Erstellt eine Liste aller in dem Katalog vorhanden in den einzelnen Schulformen gültigen Jahrgänge. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Jahrgangs-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Jahrgangs-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Jahrgangs-Katalog-Einträgen */ getKatalogJahrgaenge(schema: string): Promise>; /** * Implementierung der POST-Methode addJahrgang für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/create * * Erstellt einen neuen Jahrgang und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten der Jahrgänge besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Jahrgang wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: JahrgangsDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Jahrgang für die Schule anzulegen. * Code 404: Die Jahrgangsdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Jahrgang wurde erfolgreich hinzugefügt. */ addJahrgang(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteJahrgaenge für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/delete/multiple * * Entfernt mehrere Jahrgänge. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Jahrgängen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Jahrgänge wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Jahrgang zu bearbeiten. * Code 404: Ein Jahrgang oder mehrere Jahrgänge nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Jahrgänge wurde erfolgreich entfernt. */ deleteJahrgaenge(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getJahrgangsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/jahrgaenge/jahrgangsdaten * * Erstellt eine Liste aller in der Datenbank vorhanden Jahrgangsdaten insofern der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Jahrgangs-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Jahrgangsdaten anzusehen. * Code 404: Keine Jahrgangs-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Jahrgangs-Listen-Einträgen */ getJahrgangsdaten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKAoAAnschlussoptionen für den Zugriff auf die URL https://{hostname}/db/{schema}/kaoa/allgemein/anschlussoptionen * * Die Liste der Einträge aus dem KAoA-Katalog Anschlussoptionen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den KAoA-Katalog Anschlussoptionen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den KAoA-Katalog Anschlussoptionen */ getKatalogKAoAAnschlussoptionen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKAoABerufsfelder für den Zugriff auf die URL https://{hostname}/db/{schema}/kaoa/allgemein/berufsfelder * * Die Liste der Einträge aus dem KAoA-Katalog Berufsfelder. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den KAoA-Katalog Berufsfelder * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den KAoA-Katalog Berufsfelder */ getKatalogKAoABerufsfelder(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKAoAEbene4 für den Zugriff auf die URL https://{hostname}/db/{schema}/kaoa/allgemein/ebene4 * * Die Liste der Einträge aus dem KAoA-Katalog Einträge der SBO Ebene 4. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den KAoA-Katalog Einträge der SBO Ebene 4 * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den KAoA-Katalog Einträge der SBO Ebene 4 */ getKatalogKAoAEbene4(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKAoAKategorien für den Zugriff auf die URL https://{hostname}/db/{schema}/kaoa/allgemein/kategorien * * Die Liste der Einträge aus dem KAoA-Katalog Kategorien. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den KAoA-Katalog Kategorien * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den KAoA-Katalog Kategorien */ getKatalogKAoAKategorien(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKAoAMerkmale für den Zugriff auf die URL https://{hostname}/db/{schema}/kaoa/allgemein/merkmale * * Die Liste der Einträge aus dem KAoA-Katalog Merkmale. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den KAoA-Katalog Merkmale * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den KAoA-Katalog Merkmale */ getKatalogKAoAMerkmale(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKAoAZusatzmerkmale für den Zugriff auf die URL https://{hostname}/db/{schema}/kaoa/allgemein/zusatzmerkmale * * Die Liste der Einträge aus dem KAoA-Katalog Zusatzmerkmale. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den KAoA-Katalog Zusatzmerkmale * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den KAoA-Katalog Zusatzmerkmale */ getKatalogKAoAZusatzmerkmale(schema: string): Promise>; /** * Implementierung der GET-Methode getKindergaerten für den Zugriff auf die URL https://{hostname}/db/{schema}/kindergaerten * * Gibt die Kindergärten zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getKindergaerten(schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteKindergaerten für den Zugriff auf die URL https://{hostname}/db/{schema}/kindergaerten/delete/multiple * * Entfernt mehrere Kindergärten, insofern, die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Kindergärten wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kindergärten nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Kindergärten wurden erfolgreich entfernt. */ deleteKindergaerten(data: List, schema: string): Promise>; /** * Implementierung der PATCH-Methode patchKindergarten für den Zugriff auf die URL https://{hostname}/db/{schema}/kindergarten/{id : \d+} * * Patched den Kindergarten mit der angegebenen ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Kindergarten-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kindergarten-Daten zu ändern. * Code 404: Kein Kindergarten mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchKindergarten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addKindergarten für den Zugriff auf die URL https://{hostname}/db/{schema}/kindergarten/create * * Erstellt einen neuen Kindergarten, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Kindergarten wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: Kindergarten * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Telefonart anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Kindergarten wurde erfolgreich angelegt. */ addKindergarten(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getKlasse für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/{id : \d+} * * Liest die Daten der Klasse zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Klassendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Klasse * - Mime-Type: application/json * - Rückgabe-Typ: KlassenDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Klassendaten anzusehen. * Code 404: Kein Klassen-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Klasse */ getKlasse(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchKlasse für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/{id : \d+} * * Passt die Daten der Klasse mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Klassendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchKlasse(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKlassenFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/abschnitt/{abschnitt : \d+} * * Erstellt eine Liste aller in der Datenbank vorhanden Klassen unter Angabe der ID, des Kürzels, der Parallelität, der Kürzel des Klassenlehrers und des zweiten Klassenlehrers, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Klassendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Klassen-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Klassendaten anzusehen. * Code 404: Keine Klassen-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Eine Liste von Klassen-Listen-Einträgen */ getKlassenFuerAbschnitt(schema: string, abschnitt: number): Promise>; /** * Implementierung der POST-Methode setKlassenSortierungFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/abschnitt/{abschnitt : \d+}/sortierung/setdefault * * Setzte eine Default-Sortierung für die Klassen anhand der Sortierung der Jahrgänge und der Parallelität der Klassen.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anpassen von Klassendaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die Default-Sortierung wurde erfolgreich gesetzt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Klassendaten anzupassen. * Code 404: Keine Jahrgangs- oder Klassen-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt */ setKlassenSortierungFuerAbschnitt(schema: string, abschnitt: number): Promise; /** * Implementierung der GET-Methode getKatalogKlassenarten für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/allgemein/klassenarten * * Erstellt eine Liste aller in dem Katalog vorhanden gültigen Klassenarten. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Klassenart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Klassenart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Klassenart-Katalog-Einträgen */ getKatalogKlassenarten(schema: string): Promise>; /** * Implementierung der POST-Methode addKlasse für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/create * * Erstellt eine neue Klasse und gibt die zugehörigen Daten zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Klasse besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Klasse wurde erfolgreich erstellt. * - Mime-Type: application/json * - Rückgabe-Typ: KlassenDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Klasse anzulegen. * Code 404: Benötigte Daten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Klasse wurde erfolgreich erstellt. */ addKlasse(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteKlassen für den Zugriff auf die URL https://{hostname}/db/{schema}/klassen/delete/multiple * * Entfernt mehrere Klassen. Dabei wird geprüft, ob alle Vorbedingungen zum Entfernender Klassen erfüllt sind und der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Klassen zu entfernen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteKlassen(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getKurse für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/ * * Erstellt eine Liste aller in der Datenbank vorhanden Kurse unter Angabe der ID, des Kürzels, der Parallelität, der Kürzel des Klassenlehrers und des zweiten Klassenlehrers, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Klassendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Kurs-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kursdaten anzusehen. * Code 404: Keine Kurs-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Kurs-Listen-Einträgen */ getKurse(schema: string): Promise>; /** * Implementierung der GET-Methode getKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/{id : \d+} * * Liest die Daten des Kurses zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Kursdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Kurses * - Mime-Type: application/json * - Rückgabe-Typ: KursDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kursdaten anzusehen. * Code 404: Kein Kurs-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Kurses */ getKurs(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/{id : \d+} * * Passt die Daten des Kurses mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Kursdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchKurs(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKursLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/{idKurs : \d+}/kursLehrer * * Liefert zu der ID des Kurses die zugehörigen Kurslehrer, insofern der Benutzer die notwendigen Berechtigungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Kurslehrer des Kurses * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Kursdaten anzusehen. * Code 404: Keine Kurslehrer für den Kurs mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} idKurs - der Pfad-Parameter idKurs * * @returns Die Kurslehrer des Kurses */ getKursLehrer(schema: string, idKurs: number): Promise>; /** * Implementierung der PATCH-Methode patchKursLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/{idKurs: \d+}/kursLehrer/{idLehrer: \d+} * * Patched den Kurslehrer mit der angegeben ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idKurs - der Pfad-Parameter idKurs * @param {number} idLehrer - der Pfad-Parameter idLehrer */ patchKursLehrer(data: Partial, schema: string, idKurs: number, idLehrer: number): Promise; /** * Implementierung der POST-Methode addKursLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/{idKurs: \d+}/kursLehrer/create * * Erstellt einen neuen Kurslehrer, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 201: Der KursLehrer wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: KursLehrer * Code 403: Der SVWS-Benutzer hat keine Rechte, um KursLehrer anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idKurs - der Pfad-Parameter idKurs * * @returns Der KursLehrer wurde erfolgreich hinzugefügt. */ addKursLehrer(data: Partial, schema: string, idKurs: number): Promise; /** * Implementierung der DELETE-Methode deleteKursLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/{idKurs: \d+}/kursLehrer/delete/multiple * * Entfernt mehrere KursLehrer, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um KursLehrer zu entfernen. * Code 404: KursLehrer nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idKurs - der Pfad-Parameter idKurs * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteKursLehrer(data: List, schema: string, idKurs: number): Promise>; /** * Implementierung der GET-Methode getKurseFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/abschnitt/{abschnitt : \d+} * * Erstellt eine Liste aller in der Datenbank vorhanden Kurse eines Schuljahresabschnittes unter Angabe der ID, des Kürzels, der Parallelität, der Kürzel des Klassenlehrers und des zweiten Klassenlehrers, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Klassendaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Kurs-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kursdaten anzusehen. * Code 404: Keine Kurs-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Eine Liste von Kurs-Listen-Einträgen */ getKurseFuerAbschnitt(schema: string, abschnitt: number): Promise>; /** * Implementierung der GET-Methode getKatalogKursarten für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/allgemein/kursarten * * Erstellt eine Liste aller in dem Katalog vorhanden gültigen Kursarten. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Kursart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Kursart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Kursart-Katalog-Einträgen */ getKatalogKursarten(schema: string): Promise>; /** * Implementierung der POST-Methode addKurs für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/create * * Erstellt einen neuen Kurs und gibt die zugehörigen Daten zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Kurses besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Kurs wurde erfolgreich erstellt. * - Mime-Type: application/json * - Rückgabe-Typ: KursDaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Kurs anzulegen. * Code 404: Der Schuljahresabschnitt, das Fach oder der Lehrer wurde nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Kurs wurde erfolgreich erstellt. */ addKurs(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteKurse für den Zugriff auf die URL https://{hostname}/db/{schema}/kurse/delete/multiple * * Entfernt mehrere Kurse. Dabei wird geprüft, ob alle Vorbedingungen zum Entfernender Kurse erfüllt sind und der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kurse zu entfernen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteKurse(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/ * * Erstellt eine Liste aller in der Datenbank vorhanden Lehrer unter Angabe der ID, des Kürzels, des Vor- und Nachnamens, der sog. Personentyps, einer Sortierreihenfolge, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen sowie ob sie für die Schulstatistik relevant sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehrer-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten anzusehen. * Code 404: Keine Lehrer-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Lehrer-Listen-Einträgen */ getLehrer(schema: string): Promise>; /** * Implementierung der GET-Methode getLehrerLernplattformen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/lernplattformen * * Liest die Lernplattformen des Lehrers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Lernplattformen des Lehrers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Lehrerdaten anzusehen. * Code 404: Keine Lernplattform für den Lehrer mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Lernplattformen des Lehrers */ getLehrerLernplattformen(schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchLehrerLernplattform für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/lernplattformen/{idLernplattform : \d+} * * Passt die Einwilligung zu der angegebenen Lehrer- und Einwilligungsart-ID an und speichert das Ergebnis in der Datenbank.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Einwilligungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lernplattform integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lernplattform der Lehrer zu ändern. * Code 404: Kein Lehrer oder keine Lernplattform der angegebenen Art gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde. (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} idLernplattform - der Pfad-Parameter idLernplattform */ patchLehrerLernplattform(data: Partial, schema: string, id: number, idLernplattform: number): Promise; /** * Implementierung der GET-Methode getLehrerPersonaldaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/personaldaten * * Liest die Personaldaten des Lehrers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Personaldaten des Lehrers * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonaldaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten anzusehen. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Personaldaten des Lehrers */ getLehrerPersonaldaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerPersonaldaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/personaldaten * * Passt die Lehrer-Personaldaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lehrer-Personaldaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten zu ändern. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerPersonaldaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getLehrerLehraemter für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/personaldaten/lehraemter * * Liest zugehörigen Daten zu den Lehrämtern des Lehrers mit der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die zugehörigen Daten zu den Lehrämtern des Lehrers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerpersonaldaten anzusehen. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die zugehörigen Daten zu den Lehrämtern des Lehrers */ getLehrerLehraemter(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getLehrerLehramtFachrichtungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/personaldaten/lehramt/fachrichtungen * * Liest zugehörigen Daten zu den Fachrichtungen des Lehramtes mit der angegebenen ID eines Lehrers aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die zugehörigen Daten zu den Fachrichtungen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerpersonaldaten anzusehen. * Code 404: Kein Lehramts-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die zugehörigen Daten zu den Fachrichtungen */ getLehrerLehramtFachrichtungen(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getLehrerLehramtLehrbefaehigungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/personaldaten/lehramt/lehrbefaehigungen * * Liest zugehörigen Daten zu den Lehrbefähigungen des Lehramtes mit der angegebenen ID eines Lehrers aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die zugehörigen Daten zu den Lehrbefähigungen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerpersonaldaten anzusehen. * Code 404: Kein Lehramts-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die zugehörigen Daten zu den Lehrbefähigungen */ getLehrerLehramtLehrbefaehigungen(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getLehrerStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/stammdaten * * Liest die Stammdaten des Lehrers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten des Lehrers * - Mime-Type: application/json * - Rückgabe-Typ: LehrerStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten anzusehen. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Stammdaten des Lehrers */ getLehrerStammdaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{id : \d+}/stammdaten * * Passt die Lehrer-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lehrer-Stammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten zu ändern. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerStammdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getLehrerEinwilligungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{idLehrer : \d+}/einwilligungen * * Liest die Einwilligungen des Lehrers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Einwilligungen des Lehrers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Lehrerdaten anzusehen. * Code 404: Keine Einwilligungen für den Lehrer mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} idLehrer - der Pfad-Parameter idLehrer * * @returns Die Einwilligungen des Lehrers */ getLehrerEinwilligungen(schema: string, idLehrer: number): Promise>; /** * Implementierung der PATCH-Methode patchLehrerEinwilligung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/{idLehrer : \d+}/einwilligungen/{idEinwilligungsart : \d+} * * Passt die Einwilligung zu der angegebenen Lehrer- und Einwilligungsart-ID an und speichert das Ergebnis in der Datenbank.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrereinwilligungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lehrereinwilligung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Einwilligungen der Lehrer zu ändern. * Code 404: Kein Lehrer oder keine Einwilligung der angegebenen Art gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde. (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idLehrer - der Pfad-Parameter idLehrer * @param {number} idEinwilligungsart - der Pfad-Parameter idEinwilligungsart */ patchLehrerEinwilligung(data: Partial, schema: string, idLehrer: number, idEinwilligungsart: number): Promise; /** * Implementierung der GET-Methode getLehrerFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/abschnitt/{abschnitt : \d+} * * Erstellt eine Liste aller in der Datenbank vorhanden Lehrer eines Schuljahresabschnittes unter Angabe der ID, des Kürzels, des Vor- und Nachnamens, der sog. Personentyps, einer Sortierreihenfolge, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen sowie ob sie für die Schulstatistik relevant sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehrer-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten anzusehen. * Code 404: Keine Lehrer-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Eine Liste von Lehrer-Listen-Einträgen */ getLehrerFuerAbschnitt(schema: string, abschnitt: number): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerAbgangsgruende für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/abgangsgruende * * Erstellt eine Liste aller in dem Katalog vorhanden Lehrerabgangsgründe unter Angabe der ID, der Bezeichnung und des Statistikschlüssels. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehrerabgangsgrund-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Lehrerabgangsgrund-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Lehrerabgangsgrund-Katalog-Einträgen */ getKatalogLehrerAbgangsgruende(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerAnrechnungsgruende für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/anrechnungsgruende * * Erstellt eine Liste aller in dem Katalog vorhanden Gründe für Anrechnungsstunden von Lehrern.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Einträgen für Gründe von Anrechnungsstunden von Lehrern * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Einträgen für Gründe von Anrechnungsstunden von Lehrern */ getKatalogLehrerAnrechnungsgruende(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerBeschaeftigungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/beschaeftigungsarten * * Erstellt eine Liste aller in dem Katalog vorhanden Beschäftigungsarten unter Angabe der ID, eines Kürzels und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Beschäftigungsart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Beschäftigungsart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Beschäftigungsart-Katalog-Einträgen */ getKatalogLehrerBeschaeftigungsarten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerEinsatzstatus für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/einsatzstatus * * Erstellt eine Liste aller in dem Katalog vorhanden Einsatzstatusarten unter Angabe der ID, eines Kürzels und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Einsatzstatus-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Einsatzstatus-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Einsatzstatus-Katalog-Einträgen */ getKatalogLehrerEinsatzstatus(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerFachrichtungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/fachrichtungen * * Erstellt eine Liste aller in dem Katalog vorhanden Fachrichtungen von Lehrern. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Fachrichtungens-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Fachrichtungs-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Fachrichtungens-Katalog-Einträgen */ getKatalogLehrerFachrichtungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerFachrichtungAnerkennungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/fachrichtungen_anerkennungen * * Erstellt eine Liste aller in dem Katalog vorhanden Anerkennungen von Fachrichtungen für Lehrer. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Anerkennungs-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Anerkennungs-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Anerkennungs-Katalog-Einträgen */ getKatalogLehrerFachrichtungAnerkennungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerLehraemter für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/lehraemter * * Erstellt eine Liste aller in dem Katalog vorhanden Lehrämter. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehramt-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Lehramt-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Lehramt-Katalog-Einträgen */ getKatalogLehrerLehraemter(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerLehramtAnerkennungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/lehraemter_anerkennungen * * Erstellt eine Liste aller Anerkennungen von Lehrämtern. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Anerkennungs-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Anerkennungs-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Anerkennungs-Katalog-Einträgen */ getKatalogLehrerLehramtAnerkennungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerLehrbefaehigungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/lehrbefaehigungen * * Erstellt eine Liste aller in dem Katalog vorhanden Lehrbefähigungen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehrbefähigung-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Lehrbefähigung-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Lehrbefähigung-Katalog-Einträgen */ getKatalogLehrerLehrbefaehigungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerLehrbefaehigungenAnerkennungen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/lehrbefaehigungen_anerkennungen * * Erstellt eine Liste aller in dem Katalog vorhanden Anerkennungen von Lehrbefähigungen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Einsatzstatus-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Anerkennungs-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Einsatzstatus-Katalog-Einträgen */ getKatalogLehrerLehrbefaehigungenAnerkennungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerMehrleistungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/mehrleistungsarten * * Erstellt eine Liste aller in dem Katalog vorhanden die Arten von Mehrleistungen durch Lehrer. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Mehrleistungsart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Mehrleistungsart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Mehrleistungsart-Katalog-Einträgen */ getKatalogLehrerMehrleistungsarten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerMinderleistungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/minderleistungsarten * * Erstellt eine Liste aller in dem Katalog vorhanden Arten von Minderleistungen durch Lehrer. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Minderleistungsart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Minderleistungsart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Minderleistungsart-Katalog-Einträgen */ getKatalogLehrerMinderleistungsarten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerRechtsverhaeltnisse für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/rechtsverhaeltnisse * * Erstellt eine Liste aller in dem Katalog vorhanden Rechtsverhältnisse unter Angabe der ID, eines Kürzels und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Rechtsverhältnis-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Rechtsverhältnis-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Rechtsverhältnis-Katalog-Einträgen */ getKatalogLehrerRechtsverhaeltnisse(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogLehrerZugangsgruende für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/allgemein/zugangsgruende * * Erstellt eine Liste aller in dem Katalog vorhanden Lehrerzugangsgründe unter Angabe der ID, der Bezeichnung und des Statistikschlüssels. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehrerzugangsgrund-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Lehrerzugangsgrund-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Lehrerzugangsgrund-Katalog-Einträgen */ getKatalogLehrerZugangsgruende(schema: string): Promise>; /** * Implementierung der POST-Methode addLehrerStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/create * * Erstellt neue LehrerStammdaten und gibt das erstellte Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer LehrerStammdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die LehrerStammdaten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um LehrerStammdaten anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die LehrerStammdaten wurden erfolgreich hinzugefügt. */ addLehrerStammdaten(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/delete/multiple * * Entfernt mehrere Lehrer. Dabei wird geprüft, ob alle Vorbedingungen zum Entfernender Lehrer erfüllt sind und der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer zu entfernen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteLehrer(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getLehrerLeitungsfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/leitungsfunktionen * * Erstellt eine Liste aller in dem Katalog vorhanden Lehrerleitungsfunktionen unter Angabe der ID und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Lehrerleitungsfunktion-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Lehrerleitungsfunktion-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Lehrerleitungsfunktion-Katalog-Einträgen */ getLehrerLeitungsfunktionen(schema: string): Promise>; /** * Implementierung der GET-Methode getLehrerPersonalabschnittsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/{id : \d+} * * Liest die Personalabschnittsdaten zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Personalabschnittsdaten * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten anzusehen. * Code 404: Keine Lehrer-Personalabschnittsdaten mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Personalabschnittsdaten */ getLehrerPersonalabschnittsdaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerPersonalabschnittsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/{id : \d+} * * Passt die Lehrer-Personalabschnittsdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personalabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lehrer-Personalabschnittsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten zu ändern. * Code 404: Keine Personalabschnittsdaten mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerPersonalabschnittsdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getLehrerPersonalabschnittsdatenAllgemeineAnrechnung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/anrechnung/{id : \d+} * * Liest die allgemeine Anrechnung zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die allgemeine Anrechnung * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten anzusehen. * Code 404: Keine allgemeine Anrechnung mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die allgemeine Anrechnung */ getLehrerPersonalabschnittsdatenAllgemeineAnrechnung(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerPersonalabschnittsdatenAllgemeineAnrechnung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/anrechnung/{id : \d+} * * Entfernt die allgemeine Anrechnung zu der angegebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen der allgemeinen Anrechnun hat. * * Mögliche HTTP-Antworten: * Code 200: Die allgemeine Anrechnung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine allgemeine Anrechnung zu löschen. * Code 404: Keine allgemeine Anrechnung mit der angegebenen ID gefunden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die allgemeine Anrechnung wurde erfolgreich entfernt. */ deleteLehrerPersonalabschnittsdatenAllgemeineAnrechnung(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerPersonalabschnittsdatenAllgemeineAnrechnung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/anrechnung/{id : \d+} * * Passt die allgemeine Anrechnung zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personalabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die allgemeine Anrechnung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten zu ändern. * Code 404: Keine allgemeine Anrechnung mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerPersonalabschnittsdatenAllgemeineAnrechnung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addLehrerPersonalabschnittsdatenAllgemeineAnrechnung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/anrechnung/add * * Erstellt einen neuen Datensatz für für eine Mehrleistung in den Personalabschnittsdaten eines Lehrers und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer Entlastungsstunden besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die allgemeine Anrechnung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine allgemeine Anrechnung anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die allgemeine Anrechnung wurde erfolgreich hinzugefügt. */ addLehrerPersonalabschnittsdatenAllgemeineAnrechnung(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerPersonalabschnittsdatenLehrerfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/lehrerfunktionen/{id : \d+} * * Liest die Lehrerfunktion zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Funktion * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenLehrerfunktion * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten anzusehen. * Code 404: Keine Lehrerfunktion mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Funktion */ getLehrerPersonalabschnittsdatenLehrerfunktionen(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerPersonalabschnittsdatenLehrerfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/lehrerfunktionen/{id : \d+} * * Passt die Lehrerfunktion zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personalabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lehrerfunktion integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten zu ändern. * Code 404: Keine Lehrerfunktion mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerPersonalabschnittsdatenLehrerfunktionen(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerPersonalabschnittsdatenLehrerfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/lehrerfunktionen/{id : \d+} * * Entfernt die Lehrerfunktion zu der angegebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen einer Lehrerfunktion hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lehrerfunktion wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenLehrerfunktion * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Lehrerfunktion zu löschen. * Code 404: Keine Lehrerfunktion mit der angegebenen ID gefunden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Lehrerfunktion wurde erfolgreich entfernt. */ deleteLehrerPersonalabschnittsdatenLehrerfunktionen(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addLehrerPersonalabschnittsdatenLehrerfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/lehrerfunktionen/add * * Erstellt einen neuen Datensatz für eine Lehrerfunktion und gibt das zugehörige Objekt zurück.. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer Lehrerfunktion besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Lehrerfunktion wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenLehrerfunktion * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Lehrerfunktion anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lehrerfunktion wurde erfolgreich hinzugefügt. */ addLehrerPersonalabschnittsdatenLehrerfunktionen(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerPersonalabschnittsdatenMehrleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/mehrleistung/{id : \d+} * * Liest die Mehrleistung zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Mehrleistung * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten anzusehen. * Code 404: Keine Mehrleistung mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Mehrleistung */ getLehrerPersonalabschnittsdatenMehrleistung(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerPersonalabschnittsdatenMehrleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/mehrleistung/{id : \d+} * * Entfernt die Mehrleistung zu der angegebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen der Mehrleistung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Mehrleistung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Mehrleistung zu löschen. * Code 404: Keine Mehrleistung mit der angegebenen ID gefunden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Mehrleistung wurde erfolgreich entfernt. */ deleteLehrerPersonalabschnittsdatenMehrleistung(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerPersonalabschnittsdatenMehrleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/mehrleistung/{id : \d+} * * Passt die Mehrleistung zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personalabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Mehrleistung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten zu ändern. * Code 404: Keine Mehrleistung mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerPersonalabschnittsdatenMehrleistung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addLehrerPersonalabschnittsdatenMehrleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/mehrleistung/add * * Erstellt einen neuen Datensatz für für eine Mehrleistung in den Personalabschnittsdaten eines Lehrers und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer Entlastungsstunden besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Mehrleistung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um Mehrleistungen anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Mehrleistung wurde erfolgreich hinzugefügt. */ addLehrerPersonalabschnittsdatenMehrleistung(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerPersonalabschnittsdatenMinderleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/minderleistung/{id : \d+} * * Liest die Minderleistung zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Minderleistung * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten anzusehen. * Code 404: Keine Minderleistung mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Minderleistung */ getLehrerPersonalabschnittsdatenMinderleistung(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerPersonalabschnittsdatenMinderleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/minderleistung/{id : \d+} * * Entfernt die Minderleistung zu der angegebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen der Minderleistung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Minderleistung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Minderleistung zu löschen. * Code 404: Keine Minderleistung mit der angegebenen ID gefunden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Minderleistung wurde erfolgreich entfernt. */ deleteLehrerPersonalabschnittsdatenMinderleistung(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerPersonalabschnittsdatenMinderleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/minderleistung/{id : \d+} * * Passt die Minderleistung zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personalabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Minderleistung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrer-Personaldaten zu ändern. * Code 404: Keine Minderleistung mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerPersonalabschnittsdatenMinderleistung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addLehrerPersonalabschnittsdatenMinderleistung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personalabschnittsdaten/minderleistung/add * * Erstellt einen neuen Datensatz für für eine Minderleistung in den Personalabschnittsdaten eines Lehrers und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer Entlastungsstunden besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Minderleistung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerPersonalabschnittsdatenAnrechnungsstunden * Code 403: Der SVWS-Benutzer hat keine Rechte, um Minderleistungen anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Minderleistung wurde erfolgreich hinzugefügt. */ addLehrerPersonalabschnittsdatenMinderleistung(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addLehrerLehramt für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt * * Erstellt einen neuen Datensatz für ein Lehramt in den Personaldaten eines Lehrers und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Das Lehramt wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerLehramtEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um ein Lehramt hinzuzufügen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Das Lehramt wurde erfolgreich hinzugefügt. */ addLehrerLehramt(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerLehramt für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/{idLehramt : \d+} * * Liest die Daten des Lehramtes eines Lehrers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten zu dem Lehramt * - Mime-Type: application/json * - Rückgabe-Typ: LehrerLehramtEintrag * Code 400: Die Anfrage ist fehlerhaft. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten anzusehen. * Code 404: Kein Lehramts-Eintrag mit der angegebenen ID gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} idLehramt - der Pfad-Parameter idLehramt * * @returns Die Daten zu dem Lehramt */ getLehrerLehramt(schema: string, idLehramt: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerLehramt für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/{idLehramt : \d+} * * Passt den Lehramtseintrag zu den angegebenen IDs an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Lehramts-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idLehramt - der Pfad-Parameter idLehramt */ patchLehrerLehramt(data: Partial, schema: string, idLehramt: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerLehramt für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/{idLehramt : \d+} * * Entfernt den Lehramtseintrag in den Personaldaten des Lehrers aus der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Datensatz wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerLehramtEintrag * Code 400: Die Anfrage ist fehlerhaft. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu entfernen. * Code 404: Kein Eintrag mit den angegebenen IDs gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} idLehramt - der Pfad-Parameter idLehramt * * @returns Der Datensatz wurde erfolgreich entfernt. */ deleteLehrerLehramt(schema: string, idLehramt: number): Promise; /** * Implementierung der POST-Methode addLehrerFachrichtung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/fachrichtung * * Erstellt einen neuen Datensatz für eine Fachrichtung zu einem Lehramt in den Personaldaten eines Lehrers und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Fachrichtung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerFachrichtungEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Fachrichtung hinzuzufügen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Fachrichtung wurde erfolgreich hinzugefügt. */ addLehrerFachrichtung(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerFachrichtung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/fachrichtung/{id : \d+} * * Liest die Daten des Fachrichtungseintrags mit der angegebenen ID zu einem Lehramt eines Lehrers aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten zu dem Fachrichtungseintrag * - Mime-Type: application/json * - Rückgabe-Typ: LehrerFachrichtungEintrag * Code 400: Die Anfrage ist fehlerhaft. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerpersonaldaten anzusehen. * Code 404: Kein Fachrichtungseintrag mit der angegebenen ID gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten zu dem Fachrichtungseintrag */ getLehrerFachrichtung(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerFachrichtung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/fachrichtung/{id : \d+} * * Passt den Fachrichtungseintrags zu den angegebenen IDs an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Fachrichtungseintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerFachrichtung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerFachrichtung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/fachrichtung/{id : \d+} * * Entfernt den Fachrichtungseintrag eines Lehramtes eines Lehrers aus der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Datensatz wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerFachrichtungEintrag * Code 400: Die Anfrage ist fehlerhaft. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu entfernen. * Code 404: Kein Eintrag mit den angegebenen IDs gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Datensatz wurde erfolgreich entfernt. */ deleteLehrerFachrichtung(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addLehrerLehrbefaehigung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/lehrbefaehigung * * Erstellt einen neuen Datensatz für eine Lehrbefähigung zu einem Lehramt in den Personaldaten eines Lehrers und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Lehrbefähigung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerLehrbefaehigungEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Lehrbefähigung hinzuzufügen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lehrbefähigung wurde erfolgreich hinzugefügt. */ addLehrerLehrbefaehigung(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLehrerLehrbefaehigung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/lehrbefaehigung/{id : \d+} * * Liest die Daten des Lehrbefähigungseintrags mit der angegebenen ID zu einem Lehramt eines Lehrers aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerpersonaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten zu dem Lehrbefähigungseintrag * - Mime-Type: application/json * - Rückgabe-Typ: LehrerLehrbefaehigungEintrag * Code 400: Die Anfrage ist fehlerhaft. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerpersonaldaten anzusehen. * Code 404: Kein Lehrbefähigungseintrag mit der angegebenen ID gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten zu dem Lehrbefähigungseintrag */ getLehrerLehrbefaehigung(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLehrerLehrbefaehigung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/lehrbefaehigung/{id : \d+} * * Passt den Lehrbefähigungseintrags zu den angegebenen IDs an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Lehrbefähigungseintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLehrerLehrbefaehigung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLehrerLehrbefaehigung für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/personaldaten/lehramt/lehrbefaehigung/{id : \d+} * * Entfernt den Lehrbefähigungseintrag eines Lehramtes eines Lehrers aus der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Lehrer-Personaldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Datensatz wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: LehrerLehrbefaehigungEintrag * Code 400: Die Anfrage ist fehlerhaft. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu entfernen. * Code 404: Kein Eintrag mit den angegebenen IDs gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Datensatz wurde erfolgreich entfernt. */ deleteLehrerLehrbefaehigung(schema: string, id: number): Promise; /** * Implementierung der POST-Methode getLehrerStammdatenMultiple für den Zugriff auf die URL https://{hostname}/db/{schema}/lehrer/stammdaten * * Liest die Stammdaten der Lehrer zu der angegebenen IDs aus der Datenbank und liefert diese zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Lehrerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten der Lehrer * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lehrerdaten anzusehen. * Code 404: Kein Lehrer-Eintrag mit der angegebenen ID gefunden * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Stammdaten der Lehrer */ getLehrerStammdatenMultiple(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getMerkmale für den Zugriff auf die URL https://{hostname}/db/{schema}/merkmale * * Gibt die Merkmale zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Merkmalen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Merkmale gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Merkmalen. */ getMerkmale(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchMerkmal für den Zugriff auf die URL https://{hostname}/db/{schema}/merkmale/{id : \d+} * * Patched das Merkmal mit der angegebenen ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchMerkmal(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addMerkmal für den Zugriff auf die URL https://{hostname}/db/{schema}/merkmale/create * * Erstellt ein neues Merkmal, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Das Merkmal wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Merkmal * Code 403: Der SVWS-Benutzer hat keine Rechte, um Merkmale anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Das Merkmal wurden erfolgreich hinzugefügt. */ addMerkmal(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteMerkmale für den Zugriff auf die URL https://{hostname}/db/{schema}/merkmale/delete/multiple * * Entfernt mehrere Merkmale, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Merkmale zu entfernen. * Code 404: Merkmale nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteMerkmale(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode migrateMariaDB für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mariadb * * Migriert die übergebene Datenbank in das Schema mit dem angegebenen Namen. Die Daten in diesem Schema werden ersetzt. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der MariaDB-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {DatenbankVerbindungsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Migrieren der MariaDB-Datenbank */ migrateMariaDB(data: DatenbankVerbindungsdaten, schema: string): Promise; /** * Implementierung der POST-Methode migrateMariaDBSchulnummer für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mariadb/{schulnummer:\d{6}} * * Migriert die Daten für die übergebene Schulnummer aus der übergebenen Datenbank in das Schema mit dem angegebenen Namen. Die Daten in diesem Schema werden ersetzt. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der MariaDB-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {DatenbankVerbindungsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schulnummer - der Pfad-Parameter schulnummer * * @returns Der Log vom Migrieren der MariaDB-Datenbank */ migrateMariaDBSchulnummer(data: DatenbankVerbindungsdaten, schema: string, schulnummer: number): Promise; /** * Implementierung der POST-Methode migrateMDB für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mdb * * Migriert die übergebene Datenbank in dieses Schema. Das Schema wird dabei geleert und vorhanden Daten gehen dabei verloren. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der Access-MDB-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {FormData} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Migrieren der Access-MDB-Datenbank */ migrateMDB(data: FormData, schema: string): Promise; /** * Implementierung der POST-Methode migrateMsSqlServer für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mssql * * Migriert die übergebene Datenbank in das Schema mit dem angegebenen Namen. Die Daten in diesem Schema werden ersetzt. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der SQL-Server-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {DatenbankVerbindungsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Migrieren der SQL-Server-Datenbank */ migrateMsSqlServer(data: DatenbankVerbindungsdaten, schema: string): Promise; /** * Implementierung der POST-Methode migrateMsSqlServerSchulnummer für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mssql/{schulnummer:\d{6}} * * Migriert die Daten für die übergebene Schulnummer aus der übergebenen Datenbank in das Schema mit dem angegebenen Namen. Die Daten in diesem Schema werden ersetzt. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der SQL-Server-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {DatenbankVerbindungsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schulnummer - der Pfad-Parameter schulnummer * * @returns Der Log vom Migrieren der SQL-Server-Datenbank */ migrateMsSqlServerSchulnummer(data: DatenbankVerbindungsdaten, schema: string, schulnummer: number): Promise; /** * Implementierung der POST-Methode migrateMySql für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mysql * * Migriert die übergebene Datenbank in das Schema mit dem angegebenen Namen. Die Daten in diesem Schema werden ersetzt. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der MySQL-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {DatenbankVerbindungsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Log vom Migrieren der MySQL-Datenbank */ migrateMySql(data: DatenbankVerbindungsdaten, schema: string): Promise; /** * Implementierung der POST-Methode migrateMySqlSchulnummer für den Zugriff auf die URL https://{hostname}/db/{schema}/migrate/mysql/{schulnummer:\d{6}} * * Migriert die Daten für die übergebene Schulnummer aus der übergebenen Datenbank in das Schema mit dem angegebenen Namen. Die Daten in diesem Schema werden ersetzt. * * Mögliche HTTP-Antworten: * Code 200: Der Log vom Migrieren der MySQL-Datenbank * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Das Schema darf nicht migriert werden. * Code 500: Fehler bei der Migration mit dem Log der fehlgeschlagenen Migration. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {DatenbankVerbindungsdaten} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} schulnummer - der Pfad-Parameter schulnummer * * @returns Der Log vom Migrieren der MySQL-Datenbank */ migrateMySqlSchulnummer(data: DatenbankVerbindungsdaten, schema: string, schulnummer: number): Promise; /** * Implementierung der GET-Methode getOAuthClientSecrets für den Zugriff auf die URL https://{hostname}/db/{schema}/oauth/secrets * * Gibt die OAuth2-Client-Secrets der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der OAuth2-Client-Secrets besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der OAuth2-Client-Secrets der Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Berechtigung zum Ansehen der OAuth2-Client-Secrets. * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der OAuth2-Client-Secrets der Schule. */ getOAuthClientSecrets(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchOAuthSecret für den Zugriff auf die URL https://{hostname}/db/{schema}/oauth/secrets/{id : \d+} * * Passt die OAuth2-Client-Secrets zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von OAuth2-Client-Secrets besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die OAuth2-Client-Secrets der Schule integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die OAuth2-Client-Secrets zu ändern. * Code 404: Kein OAuth2-Client-Secrets mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchOAuthSecret(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteOAuthSecret für den Zugriff auf die URL https://{hostname}/db/{schema}/oauth/secrets/{id : \d+} * * Entfernt ein OAuth2-Client-Secrets. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen von OAuth Client Secrets hat. * * Mögliche HTTP-Antworten: * Code 200: Das OAuth2-Client-Secrets wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: OAuth2ClientConnection * Code 403: Der SVWS-Benutzer hat keine Rechte, um OAuth2-Client-Secrets zu entfernen. * Code 404: OAuth2-Client-Secrets nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Das OAuth2-Client-Secrets wurde erfolgreich entfernt. */ deleteOAuthSecret(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getOAuthClientSecret für den Zugriff auf die URL https://{hostname}/db/{schema}/oauth/secrets/{id : \d+} * * Gibt das OAuth2-Client-Secrets der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von OAuth2-Client-Secrets besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das OAuth2-Client-Secrets der Schule * - Mime-Type: application/json * - Rückgabe-Typ: OAuth2ClientConnection * Code 403: Der SVWS-Benutzer hat keine Rechte, um die OAuth2-Client-Secrets anzusehen. * Code 404: Kein OAuth2-Client-Secrets mit der ID bei der Schule gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Das OAuth2-Client-Secrets der Schule */ getOAuthClientSecret(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addOAuthClientSecret für den Zugriff auf die URL https://{hostname}/db/{schema}/oauth/secrets/create * * Erstellt einen neuen Eintrag für die schulspezifischen OAuth2-Client-Secrets und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von OAuth2-Client-Secrets besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Eintrag wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: OAuth2ClientConnection * Code 400: Der Eintrag enthält Fehler, bspw. eine invalide URL. * Code 403: Der SVWS-Benutzer hat keine Rechte, um ein OAuth2-Client-Secret für die Schule anzulegen. * Code 409: Es existiert bereits ein Eintrag für den gegebenen OAuth2-Server. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Eintrag wurde erfolgreich hinzugefügt. */ addOAuthClientSecret(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getOrte für den Zugriff auf die URL https://{hostname}/db/{schema}/orte * * Erstellt eine Liste aller in dem Katalog vorhanden Orte unter Angabe der ID, der PLZ, des Ortes, ggf. des Kreises, dem Bundesland, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Orts-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Ort-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Orts-Katalog-Einträgen */ getOrte(schema: string): Promise>; /** * Implementierung der GET-Methode getOrtsteile für den Zugriff auf die URL https://{hostname}/db/{schema}/ortsteile * * Erstellt eine Liste aller in dem Katalog vorhanden Ortsteile unter Angabe der ID, der zugehörigenOrt-ID, dem Namen des Ortsteils, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Ortsteil-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Ortsteil-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Ortsteil-Katalog-Einträgen */ getOrtsteile(schema: string): Promise>; /** * Implementierung der POST-Methode pdfReport für den Zugriff auf die URL https://{hostname}/db/{schema}/reporting/ausgabe * * Erstellt den angeforderten Report gemäß den in den Reporting-Parametern angegebenen Daten und Einstellungen und bietet ihn als PDF-Datei zum Download an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Reports besitzt. Weitergehende Berechtigungen werden im Vorfeld der Reporterstellung überprüft. * * Mögliche HTTP-Antworten: * Code 200: Der Report mit den übergebenen Daten wurde erfolgreich erstellt. * - Mime-Type: application/pdf * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um den geforderten Report zu erstellen. * Code 404: Kein Eintrag zu den übergebenen Daten gefunden. * Code 500: Es ist ein unbekannter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {ReportingParameter} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Report mit den übergebenen Daten wurde erfolgreich erstellt. */ pdfReport(data: ReportingParameter, schema: string): Promise; /** * Implementierung der POST-Methode emailReport für den Zugriff auf die URL https://{hostname}/db/{schema}/reporting/email * * Erstellt den angeforderten Report gemäß den in den Reporting-Parametern angegebenen Daten und Einstellungen und versendet ihn als PDF-Datei per E-Mail. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Reports besitzt. Weitergehende Berechtigungen werden im Vorfeld der Reporterstellung überprüft. * * Mögliche HTTP-Antworten: * Code 200: Der Report mit den übergebenen Daten wurde erfolgreich erstellt und als E-Mail versendet. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * Code 403: Der SVWS-Benutzer hat keine Rechte, um den geforderten Report zu erstellen. * Code 404: Kein Eintrag zu den übergebenen Daten gefunden. * Code 500: Es ist ein unbekannter Fehler aufgetreten. * - Mime-Type: application/json * - Rückgabe-Typ: SimpleOperationResponse * * @param {ReportingParameter} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Report mit den übergebenen Daten wurde erfolgreich erstellt und als E-Mail versendet. */ emailReport(data: ReportingParameter, schema: string): Promise; /** * Implementierung der GET-Methode getKatalogSchild3AbiturInfos für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/abiturinfos * * Die Liste der Einträge aus dem Schild-Katalog AbiturInfos. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog AbiturInfos * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog AbiturInfos */ getKatalogSchild3AbiturInfos(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3Datenarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/datenarten * * Die Liste der Einträge aus dem Schild-Katalog Datenart. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog Datenart * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog Datenart */ getKatalogSchild3Datenarten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3DQRNiveaus für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/dqr_niveaus * * Die Liste der Einträge aus dem Schild-Katalog DQR-Niveaus. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog DQR-Niveaus * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog DQR-Niveaus */ getKatalogSchild3DQRNiveaus(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3ExportCSV für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/export/csv * * Die Liste der Einträge aus dem Schild-Katalog zur Konfiguration des CSV-Exportes von Schild. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog zur Konfiguration des CSV-Exportes von Schild * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog zur Konfiguration des CSV-Exportes von Schild */ getKatalogSchild3ExportCSV(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3FilterFehlendeEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/filter/fehlende_eintraege * * Die Liste der Einträge aus dem Schild-Katalog Filter Fehlende Einträge. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog Filter Fehlende Einträge * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog Filter Fehlende Einträge */ getKatalogSchild3FilterFehlendeEintraege(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3Laender für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/laender * * Die Liste der Einträge aus dem Schild-Katalog Bundesländer/Nachbarländer. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog Bundesländer/Nachbarländer * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog Bundesländer/Nachbarländer */ getKatalogSchild3Laender(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3Pruefungsordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/pruefungsordnungen * * Die Liste der Einträge aus dem Schild-Katalog Prüfungsordnungen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog Prüfungsordnungen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog Prüfungsordnungen */ getKatalogSchild3Pruefungsordnungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3PruefungsordnungOptionen für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/pruefungsordnungen/optionen * * Die Liste der Einträge aus dem Schild-Katalog Prüfungsordnung-Optionen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog Prüfungsordnung-Optionen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog Prüfungsordnung-Optionen */ getKatalogSchild3PruefungsordnungOptionen(schema: string): Promise>; /** * Implementierung der GET-Methode getSchild3ReportingDatenquellen für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/reporting/ * * Die Liste der Einträge im SVWS-Server definierten Schild3-Datenquellen für das Reporting. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung für den Zugriff auf das Reporting besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen der Einträge im SVWS-Server definierten Schild3-Datenquellen für das Reporting * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um auf das Reporting zuzigreifen. * Code 404: Keine Datenquellen gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen der Einträge im SVWS-Server definierten Schild3-Datenquellen für das Reporting */ getSchild3ReportingDatenquellen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3UnicodeUmwandlung für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/unicode/umwandlung * * Die Liste der Einträge aus dem Schild-Katalog für die Unicode-Umwandlung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog für die Unicode-Umwandlung * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog für die Unicode-Umwandlung */ getKatalogSchild3UnicodeUmwandlung(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchild3Versetzungsvermerke für den Zugriff auf die URL https://{hostname}/db/{schema}/schild3/versetzungsvermerke * * Die Liste der Einträge aus dem Schild-Katalog Versetzungsvermerke / PrfSemAbschl. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Schild-Katalog Versetzungsvermerke / PrfSemAbschl * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Schild-Katalog Versetzungsvermerke / PrfSemAbschl */ getKatalogSchild3Versetzungsvermerke(schema: string): Promise>; /** * Implementierung der GET-Methode getSchuelerLernabschnittsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/abschnitt/{abschnitt : \d+}/lernabschnittsdaten * * Liest die Lernabschnittsdaten des Schülers zu der angegebenen ID und dem angegeben Schuljahresabschnitt aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Lernabschnittsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerLernabschnittsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Die Lernabschnittsdaten des Schülers */ getSchuelerLernabschnittsdaten(schema: string, id: number, abschnitt: number): Promise; /** * Implementierung der GET-Methode getSchuelerBetriebe für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/betriebe * * Erstellt eine Liste aller in der Datenbank vorhandenen Betriebe unter Angabe der Schüler-IDdes Vor- und Nachnamens, Erzieherart, Kontaktdaten, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Betriebsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schülerbetrieben * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherdaten anzusehen. * Code 404: Keine Erzieher-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Eine Liste von Schülerbetrieben */ getSchuelerBetriebe(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getSchuelerBetriebsstammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/betriebsstammdaten * * Erstellt eine Liste aller in der Datenbank vorhandenen Betriebe eines Schülers unter Angabe der ID,ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Betriebsdaten des Schülers besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von von Betriebsstammdaten eines Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Betriebdaten anzusehen. * Code 404: Keine Betrieb-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Eine Liste von von Betriebsstammdaten eines Schülers */ getSchuelerBetriebsstammdaten(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getSchuelerErzieher für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/erzieher * * Erstellt eine Liste aller in der Datenbank vorhandenen Erzieher unter Angabe der Schüler-IDdes Vor- und Nachnamens, Erzieherart, Kontaktdaten, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Erzieherdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Erzieherstammdaten * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherdaten anzusehen. * Code 404: Keine Erzieher-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Eine Liste von Erzieherstammdaten */ getSchuelerErzieher(schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchFahrschuelerart für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/fahrschuelerarten * * Passt die Fahrschülerart zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Fahrschülerarten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fahrschülerarten zu ändern. * Code 404: Keine Fahrschülerart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchFahrschuelerart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKAoAdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/kaoa * * Liest die KAOADaten des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die KAOADaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Kein Schüler-KAoA-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die KAOADaten des Schülers */ getKAoAdaten(schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchKAoADaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/kaoa/{skid : \d+} * * Ändert einen SchuelerKAoADaten EintragDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von SchülerKAoADaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die KAOADaten des Schülers wurden erfolgreich gepatcht * Code 400: Fehler bei der Datenvalidierung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzulegen. * Code 404: Kein Schüler-KAoA-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} skid - der Pfad-Parameter skid */ patchKAoADaten(data: Partial, schema: string, id: number, skid: number): Promise; /** * Implementierung der DELETE-Methode deleteKAoAdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/kaoa/{skid : \d+} * * Löscht einen SchuelerKAoADaten EintragDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von SchülerKAoADaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Die KAOADaten des Schülers wurden gelöscht * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzulegen. * Code 404: Kein Schüler-KAoA-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} skid - der Pfad-Parameter skid */ deleteKAoAdaten(schema: string, id: number, skid: number): Promise; /** * Implementierung der POST-Methode addKAoAdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/kaoa/create * * Erstellt einen neuen SchuelerKAoADaten EintragDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von SchülerKAoADaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die KAOADaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerKAoADaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzulegen. * Code 404: Kein Schüler-KAoA-Eintrag mit der angegebenen ID gefunden * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die KAOADaten des Schülers */ addKAoAdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchuelerLernabschnittsliste für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/lernabschnitte * * Liest eine Lister der Lernabschnitte des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schüler-Lernabschnitt-Listeneinträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Eine Liste von Schüler-Lernabschnitt-Listeneinträgen */ getSchuelerLernabschnittsliste(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getSchuelerLernplattformen für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/lernplattformen * * Liest die Lernplattformen des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Lernplattformen des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Keine Lernplattform für den Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Lernplattformen des Schülers */ getSchuelerLernplattformen(schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchSchuelerLernplattform für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/lernplattformen/{idLernplattform : \d+} * * Passt die Einwilligung zu der angegebenen Schüler- und Einwilligungsart-ID an und speichert das Ergebnis in der Datenbank.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schüler-Einwilligungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lernplattform integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lernplattform der Schüler zu ändern. * Code 404: Kein Schüler oder keine Lernplattform der angegebenen Art gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde. (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} idLernplattform - der Pfad-Parameter idLernplattform */ patchSchuelerLernplattform(data: Partial, schema: string, id: number, idLernplattform: number): Promise; /** * Implementierung der GET-Methode getSchuelerSchulbesuch für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/schulbesuch * * Liest die Schulbesuchsdaten des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schulbesuchsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerSchulbesuchsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Schulbesuchsdaten des Schülers */ getSchuelerSchulbesuch(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerSchulbesuch für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/schulbesuch * * Passt die Schüler-Schulbesuchsdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Schüler-Schulbesuchsdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuelerSchulbesuch(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchuelerSprachbelegung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprache/{sprache : [A-Z]+}/belegung * * Liest die Spachbelegungen zu der Sprache mit dem angegebenen Sprachkürzel des Schülers mit der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Spachbelegung des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: Sprachbelegung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Spachbelegung anzusehen. * Code 404: Kein Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {string} sprache - der Pfad-Parameter sprache * * @returns Die Spachbelegung des Schülers */ getSchuelerSprachbelegung(schema: string, id: number, sprache: string): Promise; /** * Implementierung der PATCH-Methode patchSchuelerSprachbelegung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprache/{sprache : [A-Z]+}/belegung * * Passt die Sprachbelegung zu der angegebenen Schüler-ID und dem angegebenen Sprachkürzel an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachbelegungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Sprachbelegung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Sprachbelegungen zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden oder keine Sprachbelegung für die Sprache gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {string} sprache - der Pfad-Parameter sprache */ patchSchuelerSprachbelegung(data: Partial, schema: string, id: number, sprache: string): Promise; /** * Implementierung der DELETE-Methode deleteSchuelerSprachbelegung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprache/{sprache : [A-Z]+}/belegung * * Entfernt eine Sprachbelegung eines Schülers.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachbelegungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Sprachbelegung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Sprachbelegung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Sprachbelegung anzulegen. * Code 404: Kein Schüler mit der angegebenen ID oder keine Sprache mit dem Kürzel gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {string} sprache - der Pfad-Parameter sprache * * @returns Die Sprachbelegung wurde erfolgreich entfernt. */ deleteSchuelerSprachbelegung(schema: string, id: number, sprache: string): Promise; /** * Implementierung der GET-Methode getSchuelerSprachpruefung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprache/{sprache : [A-Z]+}/pruefung * * Liest die Sprachprüfung zu der Sprache mit dem angegebenen Sprachkürzel des Schülers mit der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Sprachprüfung des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: Sprachpruefung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Sprachprüfung anzusehen. * Code 404: Kein Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {string} sprache - der Pfad-Parameter sprache * * @returns Die Sprachprüfung des Schülers */ getSchuelerSprachpruefung(schema: string, id: number, sprache: string): Promise; /** * Implementierung der PATCH-Methode patchSchuelerSprachpruefung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprache/{sprache : [A-Z]+}/pruefung * * Passt die Sprachprüfung zu der angegebenen Schüler-ID und dem angegebenen Sprachkürzel an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachprüfungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Sprachprüfung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Sprachprüfungen zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden oder keine Sprachprüfung für die Sprache gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {string} sprache - der Pfad-Parameter sprache */ patchSchuelerSprachpruefung(data: Partial, schema: string, id: number, sprache: string): Promise; /** * Implementierung der DELETE-Methode deleteSchuelerSprachpruefung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprache/{sprache : [A-Z]+}/pruefung * * Entfernt eine Sprachprüfung eines Schülers.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachprüfungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Sprachprüfung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Sprachpruefung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Sprachbelegung anzulegen. * Code 404: Kein Schüler mit der angegebenen ID oder keine Sprache mit dem Kürzel gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {string} sprache - der Pfad-Parameter sprache * * @returns Die Sprachprüfung wurde erfolgreich entfernt. */ deleteSchuelerSprachpruefung(schema: string, id: number, sprache: string): Promise; /** * Implementierung der GET-Methode getSchuelerSprachbelegungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprachen/belegungen * * Liest die Spachbelegungen des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Spachbelegungen des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Spachbelegungen anzusehen. * Code 404: Kein Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Spachbelegungen des Schülers */ getSchuelerSprachbelegungen(schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addSchuelerSprachbelegung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprachen/belegungen * * Erstellt eine neuen Sprachbelegung für den Schüler mit der angebenen ID. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachbelegungen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Sprachbelegung des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: Sprachbelegung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Sprachbelegung anzulegen. * Code 404: Kein Schüler mit der angegebenen ID oder keine Sprache mit dem Kürzel gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Sprachbelegung des Schülers */ addSchuelerSprachbelegung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchuelerSprachpruefungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprachen/pruefungen * * Liest die Sprachprüfungen des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Sprachprüfungen des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Sprachprüfungen anzusehen. * Code 404: Kein Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Sprachprüfungen des Schülers */ getSchuelerSprachpruefungen(schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addSchuelerSprachpruefung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/sprachen/pruefungen * * Erstellt eine neuen Sprachprüfung für den Schüler mit der angebenen ID. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachprüfungen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Sprachprüfung des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: Sprachpruefung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Sprachprüfung anzulegen. * Code 404: Kein Schüler mit der angegebenen ID gefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Sprachprüfung des Schülers */ addSchuelerSprachpruefung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchuelerStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/stammdaten * * Liest die Stammdaten des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Stammdaten des Schülers */ getSchuelerStammdaten(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/stammdaten * * Passt die Schüler-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich in die Schülerstammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuelerStammdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchuelerTelefone für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/telefone * * Liest die Telefoneinträge des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Telefoneinträge des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Keine Telefon-Eintrag für den Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Telefoneinträge des Schülers */ getSchuelerTelefone(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getVermerkdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/vermerke * * Liest die Vermerkdaten des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten und Vermerke besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Vermerkdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Kein Schüler-Vermerk-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Vermerkdaten des Schülers */ getVermerkdaten(schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteSchuelerVermerk für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{id : \d+}/vermerke/{idVermerk : \d+} * * Löscht einen Schueler-VermerkDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schüler-Vermerken besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Vermerk des Schülers wurde gelöscht * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzulegen. * Code 404: Kein Schüler-Vermerk mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} idVermerk - der Pfad-Parameter idVermerk */ deleteSchuelerVermerk(schema: string, id: number, idVermerk: number): Promise; /** * Implementierung der POST-Methode addBisherigeSchule für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{idSchueler : \d+}/bisherigeSchule * * Erstellt eine bisherige Schule, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die bisher besuchte Schule wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerSchulbesuchSchule * Code 403: Der SVWS-Benutzer hat keine Rechte, um bisherige Schulen hinzuzufügen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchueler - der Pfad-Parameter idSchueler * * @returns Die bisher besuchte Schule wurde erfolgreich hinzugefügt. */ addBisherigeSchule(data: Partial, schema: string, idSchueler: number): Promise; /** * Implementierung der GET-Methode getSchuelerEinwilligungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{idSchueler : \d+}/einwilligungen * * Liest die Einwilligungen des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Einwilligungen des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Keine Einwilligungen für den Schüler mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchueler - der Pfad-Parameter idSchueler * * @returns Die Einwilligungen des Schülers */ getSchuelerEinwilligungen(schema: string, idSchueler: number): Promise>; /** * Implementierung der PATCH-Methode patchSchuelerEinwilligung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{idSchueler : \d+}/einwilligungen/{idEinwilligungsart : \d+} * * Passt die Einwilligung zu der angegebenen Schüler- und Einwilligungsart-ID an und speichert das Ergebnis in der Datenbank.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schüler-Einwilligungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Einwilligung integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Einwilligungen der Schüler zu ändern. * Code 404: Kein Schüler oder keine Einwilligung der angegebenen Art gefunden. * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde. (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchueler - der Pfad-Parameter idSchueler * @param {number} idEinwilligungsart - der Pfad-Parameter idEinwilligungsart */ patchSchuelerEinwilligung(data: Partial, schema: string, idSchueler: number, idEinwilligungsart: number): Promise; /** * Implementierung der POST-Methode addSchuelerMerkmal für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{idSchueler : \d+}/merkmal * * Erstellt neue SchuelerMerkmale, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 201: Das SchuelerMerkmal wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerSchulbesuchMerkmal * Code 403: Der SVWS-Benutzer hat keine Rechte, um SchuelerMerkmale hinzuzufügen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchueler - der Pfad-Parameter idSchueler * * @returns Das SchuelerMerkmal wurde erfolgreich hinzugefügt. */ addSchuelerMerkmal(data: Partial, schema: string, idSchueler: number): Promise; /** * Implementierung der POST-Methode addSchuelerTelefon für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{idSchueler : \d+}/telefon * * Erstellt einen neuen Schülertelefoneintrag. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der neue Telefoneintrag für den Schüler * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerTelefon * Code 403: Der SVWS-Benutzer hat keine Rechte, um Telefoneinträge für Schüler anzulegen. * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchueler - der Pfad-Parameter idSchueler * * @returns Der neue Telefoneintrag für den Schüler */ addSchuelerTelefon(data: Partial, schema: string, idSchueler: number): Promise; /** * Implementierung der POST-Methode addSchuelerStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/{idSchuljahresabschnitt : \d+}/stammdaten/create * * Erstellt neue SchülerStammdaten und gibt das erstellte Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer SchülerStammdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die SchülerStammdaten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um SchülerStammdaten anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchuljahresabschnitt - der Pfad-Parameter idSchuljahresabschnitt * * @returns Die SchülerStammdaten wurden erfolgreich hinzugefügt. */ addSchuelerStammdaten(data: Partial, schema: string, idSchuljahresabschnitt: number): Promise; /** * Implementierung der GET-Methode getSchuelerFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/abschnitt/{abschnitt : \d+} * * Erstellt eine Liste aller Schüler mit deren Daten zum angegebenen Schuljahresabschnitt u. a. unter Angabe der ID, des Vor- und Nachnamens, der Klasse, des Jahrgangs, sein Status (z.B. aktiv), einer Sortierreihenfolge, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Die schüler sind anhand der Klasse, des Nachnamens und des Vornamens sortiert.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schüler-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Keine Schüler-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Eine Liste von Schüler-Listen-Einträgen */ getSchuelerFuerAbschnitt(schema: string, abschnitt: number): Promise>; /** * Implementierung der GET-Methode getSchuelerAuswahllisteFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/abschnitt/{abschnitt : \d+}/auswahlliste * * Gibt die Informationen zur Verwaltung einer Schüler-Auswahlliste mit Filterfunktionen in Bezug auf einen Schuljahresabschnitt zurück.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die GZip-komprimierten Daten zur Schüler-Auswahlliste * - Mime-Type: application/octet-stream * - Rückgabe-Typ: ApiFile * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Nicht alle Daten wurden gefunden, z.B. Schüler-Einträge * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Die GZip-komprimierten Daten zur Schüler-Auswahlliste */ getSchuelerAuswahllisteFuerAbschnitt(schema: string, abschnitt: number): Promise; /** * Implementierung der GET-Methode getSchuelerAktuell für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/aktuell * * Erstellt eine Liste aller im aktuellen Schuljahresabschnitt vorhanden Schüler unter Angabe der ID, des Vor- und Nachnamens, der Klasse, des Jahrgangs, sein Status (z.B. aktiv), einer Sortierreihenfolge, ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Die schüler sind anhand der Klasse, des Nachnamens und des Vornamens sortiert.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schüler-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Keine Schüler-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Schüler-Listen-Einträgen */ getSchuelerAktuell(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogHerkuenfte für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/allgemein/herkuenfte * * Erstellt eine Liste aller in dem Katalog vorhandenen Herkünfte von Schülern. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getKatalogHerkuenfte(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogHerkunftsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/allgemein/herkunftsarten * * Erstellt eine Liste aller in dem Katalog vorhandenen Herkunftsarten bei Schülern. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getKatalogHerkunftsarten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogUebergangsempfehlung für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/allgemein/uebergangsempfehlung * * Erstellt eine Liste aller in dem Katalog vorhandenen Übergangsempfehlungen der Grundschule für die Sekundarstufe I. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getKatalogUebergangsempfehlung(schema: string): Promise>; /** * Implementierung der GET-Methode getBisherigeSchule für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/bisherigeSchule/{id : \d+} * * Gibt die bisher besuchte Schule zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die bisher besuchte Schule * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerSchulbesuchSchule * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Keine bisher besuchte Schule mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die bisher besuchte Schule */ getBisherigeSchule(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchBisherigeSchule für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/bisherigeSchule/{id : \d+} * * Patcht und Persistiert eine bisher besuchte Schule, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich ausgeführt. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um bisher besuchte Schulen zu ändern. * Code 404: Keine bisher besuchte Schule mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchBisherigeSchule(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteBisherigeSchulen für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/bisherigeSchule/multiple * * Entfernt bisher besuchte Schulen, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine bisher besuchte Schule wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um bisher besuchte Schulen zu entfernen. * Code 404: Die bisher besuchten Schulen sind nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Eine bisher besuchte Schule wurde erfolgreich entfernt. */ deleteBisherigeSchulen(data: List, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteSchueler für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/delete/multiple * * Entfernt mehrere Schüler durch setzen eines Löschvermerks. Dabei wird geprüft, ob alle Vorbedingungen zum Entfernender Schüler erfüllt sind und der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schüler zu entfernen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteSchueler(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode getSchuelerEinwilligungenBySchuelerIds für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/einwilligungen * * Liest die Einwilligungen der Schüler zu der angegebenen IDs aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Einwilligungen des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Einwilligungen des Schülers */ getSchuelerEinwilligungenBySchuelerIds(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode addSchuelerErzieher für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/erzieher/new/{idSchueler : \d+}/{pos : [12]} * * Erstellt einen neuen Erziehereintrag einen Schüler. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Erzieherdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: ErzieherStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzulegen. * Code 404: Kein Schüler-Erzieher-Eintrag mit der angegebenen ID gefunden * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchueler - der Pfad-Parameter idSchueler * @param {number} pos - der Pfad-Parameter pos * * @returns Die Erzieherdaten des Schülers */ addSchuelerErzieher(data: Partial, schema: string, idSchueler: number, pos: number): Promise; /** * Implementierung der GET-Methode getFahrschuelerarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/fahrschuelerarten * * Erstellt eine Liste aller in dem Katalog vorhanden Fahrschülerarten unter Angabe der ID, eines Kürzels und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Fahrschülerarten-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Fahrschülerart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Fahrschülerarten-Katalog-Einträgen */ getFahrschuelerarten(schema: string): Promise>; /** * Implementierung der POST-Methode addFahrschuelerart für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/fahrschuelerarten/create * * Erstellt einer neuen Fahrschülerart und gibt das erstellte Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen neuer Fahrschülerarten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Fahrschülerart wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Fahrschuelerart * Code 403: Der SVWS-Benutzer hat keine Rechte, um Fahrschülerarten anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Fahrschülerart wurde erfolgreich hinzugefügt. */ addFahrschuelerart(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteFahrschuelerarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/fahrschuelerarten/delete/multiple * * Entfernt mehrere Fahrschülerarten, insofern, die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Fahrschülerarten wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Fahrschülerarten nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Fahrschülerarten wurden erfolgreich entfernt. */ deleteFahrschuelerarten(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getSchuelerLeistungsdatenByID für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/leistungsdaten/{id : \d+} * * Liest die Schülerleistungsdaten zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerleistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerLeistungsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerleistungsdaten anzusehen. * Code 404: Kein Schülerleistungsdaten-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leistungsdaten des Schülers */ getSchuelerLeistungsdatenByID(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/leistungsdaten/{id : \d+} * * Passt die Schülerleistungsdaten mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerleistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuelerLeistungsdaten(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteSchuelerLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/leistungsdaten/{id : \d+} * * Entfernt Leistungsdaten. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen von Leistungsdaten hat. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerLeistungsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Leistungsdaten zu entfernen. * Code 404: Die Leistungsdaten sind nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leistungsdaten wurde erfolgreich entfernt. */ deleteSchuelerLeistungsdaten(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addSchuelerLeistungsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/leistungsdaten/create * * Erstellt neue Leistungsdaten und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen von Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Leistungsdaten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerLeistungsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Leistungsdaten hinzuzufügen. * Code 404: Daten für die Leistungsdaten (z.B. Fächer) wurden nicht gefunden und konnten nicht zugeordnet werden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leistungsdaten wurden erfolgreich hinzugefügt. */ addSchuelerLeistungsdaten(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addSchuelerLeistungsdatenMultiple für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/leistungsdaten/create/multiple * * Erstellt mehrere Leistungsdaten und gibt die zugehörigen Objekte zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum zum Hinzufügen von Leistungsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Leistungsdaten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Leistungsdaten hinzuzufügen. * Code 404: Daten für die Leistungsdaten (z.B. Fächer) wurden nicht gefunden und konnten nicht zugeordnet werden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leistungsdaten wurden erfolgreich hinzugefügt. */ addSchuelerLeistungsdatenMultiple(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteSchuelerLeistungsdatenMultiple für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/leistungsdaten/delete/multiple * * Entfernt mehrere Leistungsdaten.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen von Leistungsdaten hat. * * Mögliche HTTP-Antworten: * Code 200: Die Leistungsdaten wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Leistungsdaten zu entfernen. * Code 404: Die Leistungsdaten sind zumindest nicht alle vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leistungsdaten wurden erfolgreich entfernt. */ deleteSchuelerLeistungsdatenMultiple(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getSchuelerLernabschnittsdatenByID für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/lernabschnittsdaten/{abschnitt : \d+} * * Liest die Schüler-Lernabschnittsdaten zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Lernabschnittsdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerLernabschnittsdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Kein Eintrag mit Schüler-Lernabschnittsdaten mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Die Lernabschnittsdaten des Schülers */ getSchuelerLernabschnittsdatenByID(schema: string, abschnitt: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerLernabschnittsdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/lernabschnittsdaten/{abschnitt : \d+} * * Passt die Schülerlernabschnittsdaten mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerlernabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt */ patchSchuelerLernabschnittsdaten(data: Partial, schema: string, abschnitt: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerLernabschnittsdatenBemerkungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/lernabschnittsdaten/{abschnitt : \d+}/bemerkungen * * Passt die Bemerkungen von Schülerlernabschnittsdaten mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerlernabschnittsdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt */ patchSchuelerLernabschnittsdatenBemerkungen(data: Partial, schema: string, abschnitt: number): Promise; /** * Implementierung der GET-Methode getSchuelerMerkmal für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/merkmal/{id : \d+} * * Gibt das SchuelerMerkmal zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das SchuelerMerkmal * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerSchulbesuchMerkmal * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Kein SchuelerMerkmal mit der angegebenen ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Das SchuelerMerkmal */ getSchuelerMerkmal(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerMerkmal für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/merkmal/{id : \d+} * * Patcht und Persistiert SchuelerMerkmale, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich ausgeführt. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um SchuelerMerkmale zu ändern. * Code 404: Kein SchuelerMerkmal mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuelerMerkmal(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteSchuelerMerkmale für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/merkmal/multiple * * Entfernt SchuelerMerkmale, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Ein SchuelerMerkmal wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um SchuelerMerkmale zu entfernen. * Code 404: Die SchuelerMerkmale sind nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Ein SchuelerMerkmal wurde erfolgreich entfernt. */ deleteSchuelerMerkmale(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode getSchuelerStammdatenMultiple für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/stammdaten * * Liest die Stammdaten der Schüler zu der angegebenen IDs aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Stammdaten des Schülers */ getSchuelerStammdatenMultiple(data: List, schema: string): Promise>; /** * Implementierung der PATCH-Methode patchSchuelerStammdatenMultiple für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/stammdaten * * Passt die Schüler-Stammdaten zu den angegebenen IDs an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich in die Schülerstammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten zu ändern. * Code 404: Ein Schüler-Eintrag mit den angegebenen IDs wurde nicht gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchSchuelerStammdatenMultiple(data: List>, schema: string): Promise; /** * Implementierung der GET-Methode getSchuelerTelefon für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/telefon/{id : \d+} * * Liest die Daten des Telefoneintrags zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Schülertelefons * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerTelefon * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Kein Telefoneintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Schülertelefons */ getSchuelerTelefon(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuelerTelefon für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/telefon/{id : \d+} * * Passt die Telefoneintrag mit der angegeben Telefon-ID an und speichert das Ergebnis in der Datenbank.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Telefoneinträgen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in den Telefoneintrag integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Telefondaten der Schüler zu ändern. * Code 404: Kein Schülertelefoneintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuelerTelefon(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteSchuelerTelefone für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/telefon/multiple * * Entfernt einen oder mehrerer Telefoneinträge bei Schülern, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Telefoneinträge wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Telefoneinträge zu entfernen. * Code 404: Mindestens ein Telefoneintrag ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Telefoneinträge wurden erfolgreich entfernt. */ deleteSchuelerTelefone(data: List, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteSchuelerVermerke für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/vermerk/multiple * * Entfernt einen oder mehrerer Vermerkeinträge bei Schülern, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Vermerkeinträge wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Vermerkeinträge zu entfernen. * Code 404: Mindestens ein Vermerkeintrag ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Vermerkeinträge wurden erfolgreich entfernt. */ deleteSchuelerVermerke(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode addVermerk für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/vermerke * * Erstellt einen neuen Vermerk EintragDabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Vermerkdaten besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Vermerke des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: SchuelerVermerke * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Vermerke anzulegen. * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Vermerke des Schülers */ addVermerk(data: Partial, schema: string): Promise; /** * Implementierung der PATCH-Methode patchSchuelerVermerke für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/vermerke/{vid : \d+} * * Passt die Vermerke zu der angegebenen Schüler-ID und der angegeben VermerkeId an und speichert das Ergebnis in der Datenbank.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Sprachbelegungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Vermerke integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Vermerkdaten der Schüler zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden oder keine Sprachbelegung für die Sprache gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} vid - der Pfad-Parameter vid */ patchSchuelerVermerke(data: Partial, schema: string, vid: number): Promise; /** * Implementierung der GET-Methode getVermerkdatenByVermerkArt für den Zugriff auf die URL https://{hostname}/db/{schema}/schueler/vermerke/vermerkart/{vermerkArt : \d+} * * Liest die Vermerkdaten des Schülers zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten und Vermerke besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Vermerkdaten des Schülers * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schülerdaten anzusehen. * Code 404: Kein Schüler-Vermerk-Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} vermerkArt - der Pfad-Parameter vermerkArt * * @returns Die Vermerkdaten des Schülers */ getVermerkdatenByVermerkArt(schema: string, vermerkArt: number): Promise>; /** * Implementierung der PATCH-Methode patchAbteilung für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/{id : \d+} * * Passt die Abteilung mit der angegebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Abteilungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchAbteilung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteAbteilung für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/{id : \d+} * * Entfernt eine Abteilung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen eines Abteilung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Abteilung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Abteilung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Keine Abteilung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Abteilung wurde erfolgreich entfernt. */ deleteAbteilung(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getAbteilungenByIdJahresAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/{idSchuljahresabschnitt : \d+} * * Erstellt eine Liste aller in der Datenbank vorhanden Abteilungen für die angegebene Id des Schuljahresabschnittes unter Angabe der ID, der Bezeichnung, der ID des Schuljahresabschnitts, der Lehrer-ID des Abteilungsleiters, die Bezeichnung des Raums des Abteilungsleiters, die eMail-Adresse des Abteilungsleiters, die interne telefonische Durchwahl des Abteilungsleiters, einer Sortierreihenfolge und und die Zuordnungen der Klassen zu der Abteilung.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Abteilungen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Abteilung-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Abteilungen anzusehen. * Code 404: Keine Abteilung-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchuljahresabschnitt - der Pfad-Parameter idSchuljahresabschnitt * * @returns Eine Liste von Abteilung-Listen-Einträgen */ getAbteilungenByIdJahresAbschnitt(schema: string, idSchuljahresabschnitt: number): Promise>; /** * Implementierung der POST-Methode addAbteilung für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/{idSchuljahresabschnitt : \d+} * * Erstellt eine neue Abteilung und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Abteilungen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Abteilung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Abteilung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idSchuljahresabschnitt - der Pfad-Parameter idSchuljahresabschnitt * * @returns Die Abteilung wurde erfolgreich hinzugefügt. */ addAbteilung(data: Partial, schema: string, idSchuljahresabschnitt: number): Promise; /** * Implementierung der DELETE-Methode deleteAbteilungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/delete/multiple * * Entfernt Abteilungen, insofern die Berechtigungen vorhanden sind * * Mögliche HTTP-Antworten: * Code 200: Die Abteilungen wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 400: Für das Löschen müssen IDs angegeben werden. Null ist nicht zulässig. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Abteilungen zu löschen. * Code 404: Es wurden keine Entitäten zu den IDs gefunden. * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Abteilungen wurden erfolgreich entfernt. */ deleteAbteilungen(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode addAbteilungKlassenzuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/klassenzuordnung * * Erstellt eine neue AbteilungenKlassenzuordnungen und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von AbteilungKlassenzuordnungen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die AbteilungenKlassenzuordnungen wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die AbteilungenKlassenzuordnungen wurde erfolgreich hinzugefügt. */ addAbteilungKlassenzuordnung(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteAbteilungKlassenzuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/abteilungen/klassenzuordnung/delete/multiple * * Entfernt AbteilungenKlassenzuordnungen, insofern der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die AbteilungenKlassenzuordnung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Keine AbteilungenKlassenzuordnung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die AbteilungenKlassenzuordnung wurde erfolgreich entfernt. */ deleteAbteilungKlassenzuordnung(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogAbgangsartenAllgemeinbildend für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/abgangsarten/allgemeinbildend * * Gibt den Katalog der Abgangsarten für allgemeinbildende Schulformen zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog * - Mime-Type: application/json * - Rückgabe-Typ: AbgangsartKatalog * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Katalog nicht gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog */ getKatalogAbgangsartenAllgemeinbildend(schema: string): Promise; /** * Implementierung der GET-Methode getKatalogAbgangsartenBerufsbildend für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/abgangsarten/berufsbildend * * Gibt den Katalog der Abgangsarten für berufsbildende Schulformen zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog * - Mime-Type: application/json * - Rückgabe-Typ: AbgangsartKatalog * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Katalog nicht gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog */ getKatalogAbgangsartenBerufsbildend(schema: string): Promise; /** * Implementierung der GET-Methode getAllgemeineMerkmale für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/allgemeine_merkmale * * Erstellt eine Liste aller in dem Katalog vorhanden Allgemeinen Merkmale bei Schulen und Schülern. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Allgemeinen-Merkmal-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Allgemeine-Merkmal-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Allgemeinen-Merkmal-Katalog-Einträgen */ getAllgemeineMerkmale(schema: string): Promise>; /** * Implementierung der GET-Methode getBerufskollegAnlagen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/berufskolleg/anlagen * * Erstellt eine Liste aller in dem Katalog vorhanden Anlagen am Berufskolleg. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Berufskolleg-Anlagen-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Berufskolleg-Anlagen-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Berufskolleg-Anlagen-Katalog-Einträgen */ getBerufskollegAnlagen(schema: string): Promise>; /** * Implementierung der GET-Methode getBerufskollegBerufsebenen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/berufskolleg/berufsebenen * * Erstellt eine Liste aller in dem Katalog vorhanden Berufsebenen am Berufskolleg. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Berufskolleg-Berufsebenen-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Berufskolleg-Berufsebenen-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Berufskolleg-Berufsebenen-Katalog-Einträgen */ getBerufskollegBerufsebenen(schema: string): Promise>; /** * Implementierung der GET-Methode getBerufskollegFachklassen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/berufskolleg/fachklassen * * Gibt den Katalog der Fachklassen am Berufskolleg zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Fachklassen-Katalog für berufsbildende Schulen * - Mime-Type: application/json * - Rückgabe-Typ: BerufskollegFachklassenKatalog * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Kein Berufskolleg-Fachklassen-Katalog gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Fachklassen-Katalog für berufsbildende Schulen */ getBerufskollegFachklassen(schema: string): Promise; /** * Implementierung der GET-Methode getEinschulungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/einschulungsarten * * Erstellt eine Liste aller in dem Katalog vorhanden Einschulungsarten. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Einschulungsart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Einschulungsart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Einschulungsart-Katalog-Einträgen */ getEinschulungsarten(schema: string): Promise>; /** * Implementierung der GET-Methode getFoerderschwerpunkte für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/foerderschwerpunkte * * Erstellt eine Liste aller in dem Katalog vorhanden Förderschwerpunkte. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Förderschwerpunkt-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Förderschwerpunkt-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Förderschwerpunkt-Katalog-Einträgen */ getFoerderschwerpunkte(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogHerkunftsschulnummern für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/herkunftsschulnummern * * Die Liste der Einträge aus dem Katalog der zusätzlichen Herkunftsschulnummern. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Katalog der zusätzlichen Herkunftsschulnummern * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Katalog der zusätzlichen Herkunftsschulnummern */ getKatalogHerkunftsschulnummern(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogKindergartenbesuchsdauer für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/kindergartenbesuch * * Erstellt eine Liste aller in dem Katalog vorhanden Dauern des Kindergartenbesuchs, welche erfasst werden. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getKatalogKindergartenbesuchsdauer(schema: string): Promise>; /** * Implementierung der GET-Methode getNationaelitaeten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/nationalitaeten * * Erstellt eine Liste aller in dem Katalog vorhanden Nationalitäten. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Nationalitäten-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Nationalitäten-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Nationalitäten-Katalog-Einträgen */ getNationaelitaeten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogNoten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/noten * * Gibt den Noten-Katalog zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Noten-Katalog. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Noten-Einträge gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Noten-Katalog. */ getKatalogNoten(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogOrganisationsformen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/organisationsformen * * Erstellt eine Liste aller in dem Katalog vorhanden gültigen Organisationsformen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Organisationsform-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Organisationsform-Katalog-Einträgen */ getKatalogOrganisationsformen(schema: string): Promise>; /** * Implementierung der GET-Methode getPruefungsordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/pruefungsordnungen * * Erstellt eine Liste aller in dem Katalog vorhanden Ausbildungs- und Prüfungsordnungen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getPruefungsordnungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogReformpaedagogik für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/reformpaedagogik * * Gibt den Reformpädagogik-Katalog für die Schulform dieser Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Reformpädagogik-Katalog für die Schulform dieser Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Reformpädagogik-Einträge für die Schulform dieser Schule gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Reformpädagogik-Katalog für die Schulform dieser Schule. */ getKatalogReformpaedagogik(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogReformpaedagogikEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/reformpaedagogik/{id : \d+} * * Gibt den Reformpädagogik-Katalog-Eintrag für die angegebene ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Reformpädagogik-Katalog-Eintrag für die angegebene ID. * - Mime-Type: application/json * - Rückgabe-Typ: ReformpaedagogikKatalogEintrag * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Kein Reformpädagogik-Katalog-Eintrag für die angegebene ID gefunden. * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Reformpädagogik-Katalog-Eintrag für die angegebene ID. */ getKatalogReformpaedagogikEintrag(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKatalogReformpaedagogikAlle für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/reformpaedagogik/alle * * Gibt den Reformpädagogik-Katalog aller Schulformen zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Reformpädagogik-Katalog aller Schulformen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Fachgruppen gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Reformpädagogik-Katalog aller Schulformen. */ getKatalogReformpaedagogikAlle(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogReligionen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/religionen * * Erstellt eine Liste aller in dem Katalog vorhanden Relgionen bzw. Konfessionen, welche im Rahmen der amtlichen Schulstatistik verwendet werden. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getKatalogReligionen(schema: string): Promise>; /** * Implementierung der GET-Methode getSchulabschluesseAllgemeinbildend für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/schulabschluesse/allgemeinbildend * * Erstellt eine Liste aller in dem Katalog vorhanden allgemeinbildenden Schulabschlüsse. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von allgemeinbildenden Abschlussart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Abschlussart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von allgemeinbildenden Abschlussart-Katalog-Einträgen */ getSchulabschluesseAllgemeinbildend(schema: string): Promise>; /** * Implementierung der GET-Methode getSchulabschluesseBerufsbildend für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/schulabschluesse/berufsbildend * * Erstellt eine Liste aller in dem Katalog vorhanden berufsbildenden Schulabschlüsse. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von berufsbildenden Abschlussart-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Abschlussart-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von berufsbildenden Abschlussart-Katalog-Einträgen */ getSchulabschluesseBerufsbildend(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchulen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/schulen * * Erstellt eine Liste aller in dem Katalog vorhandenen Schulen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schulen-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Schulen-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Schulen-Katalog-Einträgen */ getKatalogSchulen(schema: string): Promise>; /** * Implementierung der GET-Methode getSchulformen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/schulformen * * Erstellt eine Liste aller in dem Katalog vorhanden Schulformen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schulform-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Schulform-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Schulform-Katalog-Einträgen */ getSchulformen(schema: string): Promise>; /** * Implementierung der GET-Methode getSchulgliederungen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/schulgliederungen * * Erstellt eine Liste aller in dem Katalog vorhanden Schulgliederungen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schulgliederung-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Schulform-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Schulgliederung-Katalog-Einträgen */ getSchulgliederungen(schema: string): Promise>; /** * Implementierung der GET-Methode getKatalogSchultraeger für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/schultraeger * * Erstellt eine Liste aller in dem Katalog vorhandenen Schulträger. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schulträger-Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Schulträger-Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Schulträger-Katalog-Einträgen */ getKatalogSchultraeger(schema: string): Promise>; /** * Implementierung der GET-Methode getVerkehrssprachen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/allgemein/verkehrssprachen * * DEPRECATED: Erstellt eine Liste aller in dem Katalog vorhanden der Verkehrssprachen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getVerkehrssprachen(schema: string): Promise>; /** * Implementierung der GET-Methode getAufsichtsbereiche für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche * * Gibt den Katalog der Aufsichtsbereiche der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Aufsichtsbereiche der Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Aufsichtsbereichs-Einträge gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Aufsichtsbereiche der Schule. */ getAufsichtsbereiche(schema: string): Promise>; /** * Implementierung der GET-Methode getAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche/{id : \d+} * * Gibt den Aufsichtsbereich der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Aufsichtsbereich der Schule * - Mime-Type: application/json * - Rückgabe-Typ: Aufsichtsbereich * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Kein Aufsichtsbereich bei der Schule gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Aufsichtsbereich der Schule */ getAufsichtsbereich(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche/{id : \d+} * * Passt den Aufsichtsbereich der Schule mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Katalog-Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchAufsichtsbereich(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche/{id : \d+} * * Entfernt einen Aufsichtsbereich der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Der Aufsichtsbereich wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Aufsichtsbereich * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kein Aufsichtsbereich vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Aufsichtsbereich wurde erfolgreich entfernt. */ deleteAufsichtsbereich(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche/create * * Erstellt einen neuen Aufsichtsbereich für die Schule und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Aufsichtsbereich wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Aufsichtsbereich * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Aufsichtsbereich für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Aufsichtsbereich wurde erfolgreich hinzugefügt. */ addAufsichtsbereich(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addAufsichtsbereiche für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche/create/multiple * * Erstellt neue Aufsichtsbereiche für die Schule und gibt die zugehörigen Objekte zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Aufsichtsbereiche wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Aufsichtsbereiche für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Aufsichtsbereiche wurden erfolgreich hinzugefügt. */ addAufsichtsbereiche(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteAufsichtsbereiche für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/aufsichtsbereiche/delete/multiple * * Entfernt mehrere Aufsichtsbereiche der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Aufsichtsbereiche wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Aufsichtsbereich nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Aufsichtsbereiche wurde erfolgreich entfernt. */ deleteAufsichtsbereiche(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getSchuelerByEinwilligungsartID für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsart/{einwilligungsart : \d+}/schuelerinfos * * Erstellt eine Liste aller Schüler der angegebenen Einwilligungsart unter Angabe der ID.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schüler-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Keine Schüler-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} einwilligungsart - der Pfad-Parameter einwilligungsart * * @returns Eine Liste von Schüler-Listen-Einträgen */ getSchuelerByEinwilligungsartID(schema: string, einwilligungsart: number): Promise>; /** * Implementierung der GET-Methode getEinwilligungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsarten * * Erstellt eine Liste aller in dem Katalog vorhanden Einwilligungsarten unter Angabe der ID, der Bezeichnung sowie des Schlüssels, einer Sortierreihenfolge und des zugehörigen Personentyps (Schüler, Lehrer, Erzieher). Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getEinwilligungsarten(schema: string): Promise>; /** * Implementierung der GET-Methode getEinwilligungsart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsarten/{id : \d+} * * Liest die Daten der Einwilligungsart zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Einwilligungsart * - Mime-Type: application/json * - Rückgabe-Typ: Einwilligungsart * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Einwilligungsart mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Einwilligungsart */ getEinwilligungsart(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchEinwilligungsart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsarten/{id : \d+} * * Passt die Einwilligungsart-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Einwilligungsart besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Einwilligungsart-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Einwilligungsart-Daten zu ändern. * Code 404: Keine Einwilligungsart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchEinwilligungsart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteEinwilligungsart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsarten/{id : \d+} * * Entfernt eine Einwilligungsart der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Einwilligungsart wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Einwilligungsart * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Einwilligungsart nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Einwilligungsart wurde erfolgreich entfernt. */ deleteEinwilligungsart(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteEinwilligungsarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsarten/delete/multiple * * Entfernt mehrere Einwilligungsarten der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Einwilligungsarten wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Einwilligungsarten nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Einwilligungsarten wurden erfolgreich entfernt. */ deleteEinwilligungsarten(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode createEinwilligungsart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/einwilligungsarten/new * * Erstellt eine neue Einwilligungsart und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Einwilligungsart besitzt. * * Mögliche HTTP-Antworten: * Code 201: Einwilligungsart wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: Einwilligungsart * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Einwilligungsart anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Einwilligungsart wurde erfolgreich angelegt. */ createEinwilligungsart(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getErzieherart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/erzieherart/{id : \d+} * * Liest die Daten der Erzieherart zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Erzieherart * - Mime-Type: application/json * - Rückgabe-Typ: Erzieherart * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Erzieherart mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Erzieherart */ getErzieherart(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchErzieherart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/erzieherart/{id : \d+} * * Passt die Erzieherart-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Erzieherart besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Erzieherart-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Erzieherart-Daten zu ändern. * Code 404: Keine Erzieherart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchErzieherart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addErzieherart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/erzieherart/new * * Erstellt eine neue Erzieherart und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Erzieherart besitzt. * * Mögliche HTTP-Antworten: * Code 201: Telefonart wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: Erzieherart * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Erzieherart anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Telefonart wurde erfolgreich angelegt. */ addErzieherart(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getErzieherArten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/erzieherarten * * Erstellt eine Liste aller in der Datenbank vorhandenen Erzieherarten unter Angabe der ID, der Beschreibung, Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Erzieherarten * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Erzieherart-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Erzieherarten */ getErzieherArten(schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteErzieherarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/erzieherarten/delete/multiple * * Entfernt mehrere Erzieherarten der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Erzieherarten wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Erzieherarten nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Erzieherarten wurden erfolgreich entfernt. */ deleteErzieherarten(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getFloskelgruppen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskelgruppen * * Gibt die Floskelgruppen zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Floskelgruppen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Floskelgruppen. */ getFloskelgruppen(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchFloskelgruppe für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskelgruppen/{kuerzel : \S+} * * Patched die Floskelgruppe mit dem angegebenen Kürzel, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit dem angegebenen Kürzel gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {string} kuerzel - der Pfad-Parameter kuerzel */ patchFloskelgruppe(data: Partial, schema: string, kuerzel: string): Promise; /** * Implementierung der POST-Methode addFloskelgruppe für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskelgruppen/create * * Erstellt eine neue Floskelgruppe, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Die Floskelgruppe wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Floskelgruppe * Code 403: Der SVWS-Benutzer hat keine Rechte, um Floskelgruppen anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Floskelgruppe wurde erfolgreich hinzugefügt. */ addFloskelgruppe(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteFloskelgruppen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskelgruppen/delete/multiple * * Entfernt mehrere Floskelgruppen, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Floskelgruppen zu entfernen. * Code 404: Floskelgruppen nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteFloskelgruppen(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getFloskeln für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskeln * * Gibt die Floskeln zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Floskeln. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Floskeln. */ getFloskeln(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchFloskeln für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskeln/{kuerzel : \S+} * * Patched die Floskeln mit dem angegebenen Kürzel, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 204: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit dem angegebenen Kürzel gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {string} kuerzel - der Pfad-Parameter kuerzel */ patchFloskeln(data: Partial, schema: string, kuerzel: string): Promise; /** * Implementierung der POST-Methode addFloskel für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskeln/create * * Erstellt eine neue Floskel, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Die Floskel wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Floskel * Code 403: Der SVWS-Benutzer hat keine Rechte, um Floskeln anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Floskel wurde erfolgreich hinzugefügt. */ addFloskel(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteFloskeln für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/floskeln/delete/multiple * * Entfernt mehrere Floskeln, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Floskeln zu entfernen. * Code 404: Floskeln nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteFloskeln(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode initSchule für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/init/{schulnummer : \d+} * * Legt die Daten für eine neue Schule an und gibt anschließend die Schulstammdaten zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Anlegen der Schule besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schule wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: SchuleStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Schule anzulegen. * Code 404: Keine Schule mit der angegebenen Schulnummer gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde, dies ist z.B. der Fall, falls zuvor schon eine Schule angelegt wurde. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} schulnummer - der Pfad-Parameter schulnummer * * @returns Die Schule wurde erfolgreich angelegt. */ initSchule(schema: string, schulnummer: number): Promise; /** * Implementierung der GET-Methode getSchulleitungsfunktion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/{id : \d+} * * Gibt die Leitungsfunktion der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leitungsfunktion * - Mime-Type: application/json * - Rückgabe-Typ: Schulleitung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leitungsfunktion der Schule anzusehen. * Code 404: Keine Leitungsfunktion der Schule gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leitungsfunktion */ getSchulleitungsfunktion(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchulleitungsfunktion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/{id : \d+} * * Passt die Leitungsfunktion der Schule mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchulleitungsfunktion(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteSchulleitungsfunktion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/{id : \d+} * * Entfernt eine Leitungsfunktion der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Leitungsfunktion der Schule wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Schulleitung * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Leitungsfunktion der Schule zu löschen. * Code 404: Die Leitungsfunktion der Schule ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Leitungsfunktion der Schule wurde erfolgreich entfernt. */ deleteSchulleitungsfunktion(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getSchulleitungsfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/alle * * Gibt die Leitungsfunktionen der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Leitungsfunktionen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Leitungsfunktionen der Schule anzusehen. * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leitungsfunktionen */ getSchulleitungsfunktionen(schema: string): Promise>; /** * Implementierung der POST-Methode addSchulleitungsfunktion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/create * * Erstellt einen neue Leitungsfunktion der Schule und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Leitungsfunktion der Schule wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Schulleitung * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Leitungsfunktion für die Schule anzulegen. * Code 404: Der Lehrer wurde nichtgefunden. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leitungsfunktion der Schule wurde erfolgreich hinzugefügt. */ addSchulleitungsfunktion(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addSchulleitungsfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/create/multiple * * Erstellt mehrere neue Leitungsfunktion für die Schule und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Leitungsfunktionen wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Leitungsfunktion für die Schule anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leitungsfunktionen wurden erfolgreich hinzugefügt. */ addSchulleitungsfunktionen(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteSchulleitungsfunktionen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/leitungsfunktion/delete/multiple * * Entfernt mehrere Leitungsfunktionen der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Löschen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Leitungsfunktionen der Schule wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Leitungsfunktion der Schule zu löschen. * Code 404: Mindestens eine Leitungsfunktion der Schule ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Leitungsfunktionen der Schule wurde erfolgreich entfernt. */ deleteSchulleitungsfunktionen(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getLernplattform für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/lernplattform/{id : \d+} * * Liest die Daten der Lernplattform zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Lernplattform * - Mime-Type: application/json * - Rückgabe-Typ: Lernplattform * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Lernplattform mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Lernplattform */ getLernplattform(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchLernplattform für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/lernplattform/{id : \d+} * * Passt die Lernplattform-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Lernplattform besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Lernplattform-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Lernplattform-Daten zu ändern. * Code 404: Keine Lernplattform mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchLernplattform(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteLernplattform für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/lernplattform/{id : \d+} * * Entfernt eine Lernplattform der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lernplattform wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Lernplattform * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Lernplattform nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Lernplattform wurde erfolgreich entfernt. */ deleteLernplattform(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addLernplattform für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/lernplattform/new * * Erstellt eine neue Lernplattform und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Lernplattform besitzt. * * Mögliche HTTP-Antworten: * Code 201: Lernplattform wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: Lernplattform * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Lernplattform anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Lernplattform wurde erfolgreich angelegt. */ addLernplattform(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getLernplattformen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/lernplattformen * * Erstellt eine Liste aller in dem Katalog vorhanden Lernplattformen unter Angabe der ID und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getLernplattformen(schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteLernplattformen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/lernplattformen/delete/multiple * * Entfernt mehrere Lernplattformen der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lernplattformen wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Lernplattformen nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lernplattformen wurden erfolgreich entfernt. */ deleteLernplattformen(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getSchullogo für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/logo * * Liest das Logo der Schule zum angegebenen Schema aus der Datenbank und liefert dieses zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schuldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das Logo der Schule * - Mime-Type: application/json * - Rückgabe-Typ: String * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten anzusehen. * Code 404: Kein Eintrag mit dem angegebenen Schema gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Das Logo der Schule */ getSchullogo(schema: string): Promise; /** * Implementierung der PUT-Methode putSchullogo für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/logo * * Setzt das Logo der Schule. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schuldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Das Logo der Schule wurde gesetzt * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten zu ändern. * Code 404: Kein Eintrag für die Schule gefunden * * @param {string | null} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ putSchullogo(data: string | null, schema: string): Promise; /** * Implementierung der GET-Methode getSchuleNummer für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/nummer * * Liefert die Schulnummer der Schule. Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen der Schuldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schulnummer * - Mime-Type: application/json * - Rückgabe-Typ: Integer * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten anzusehen. * Code 404: Keine Schule in der Datenbank vorhanden * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Schulnummer */ getSchuleNummer(schema: string): Promise; /** * Implementierung der GET-Methode getPausenzeiten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten * * Gibt den Katalog der Pausenzeiten der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Pausenzeiten der Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Pausenzeit-Einträge gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Pausenzeiten der Schule. */ getPausenzeiten(schema: string): Promise>; /** * Implementierung der GET-Methode getPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten/{id : \d+} * * Gibt die Pausenzeit der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenzeit der Schule * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenzeit * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Keine Pausenzeit mit der angegebenen ID bei der Schule gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeit der Schule */ getPausenzeit(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten/{id : \d+} * * Passt die Pausenzeit der Schule mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Katalog-Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchPausenzeit(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deletePausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten/{id : \d+} * * Entfernt eine Pausenzeit der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenzeit wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenzeit * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Keine Pausenzeit vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeit wurde erfolgreich entfernt. */ deletePausenzeit(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten/create * * Erstellt eine neue Pausenzeit für die Schule und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenzeit wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenzeit * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Pausenzeit für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Pausenzeit wurde erfolgreich hinzugefügt. */ addPausenzeit(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addPausenzeiten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten/create/multiple * * Erstellt neue Pausenzeiten für die Schule und gibt die zugehörigen Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenzeiten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Pausenzeiten für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Pausenzeiten wurden erfolgreich hinzugefügt. */ addPausenzeiten(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deletePausenzeiten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/pausenzeiten/delete/multiple * * Entfernt mehrere Pausenzeiten der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenzeiten wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Räume nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Pausenzeiten wurde erfolgreich entfernt. */ deletePausenzeiten(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getRaeume für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume * * Gibt den Katalog der Räume der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Katalog der Räume der Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Raum-Einträge gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Katalog der Räume der Schule. */ getRaeume(schema: string): Promise>; /** * Implementierung der GET-Methode getRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume/{id : \d+} * * Gibt den Raum der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Raum der Schule * - Mime-Type: application/json * - Rückgabe-Typ: Raum * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Kein Raum bei der Schule gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Raum der Schule */ getRaum(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume/{id : \d+} * * Passt den Raum der Schule mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Katalog-Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde(z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchRaum(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume/{id : \d+} * * Entfernt einen Raum der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Der Raum wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: Raum * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kein Raum vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Raum wurde erfolgreich entfernt. */ deleteRaum(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume/create * * Erstellt einen neuen Raum für die Schule und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Raum wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Raum * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Raum für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Raum wurde erfolgreich hinzugefügt. */ addRaum(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addRaeume für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume/create/multiple * * Erstellt neue Räume für die Schule und gibt die zugehörigen Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Räume wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Räume für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Räume wurden erfolgreich hinzugefügt. */ addRaeume(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteRaeume für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/raeume/delete/multiple * * Entfernt mehrere Räume der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Räume wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Räume nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Räume wurde erfolgreich entfernt. */ deleteRaeume(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getReligionen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/religionen * * Erstellt eine Liste aller in dem Katalog vorhanden Religionen bzw. Konfessionen unter Angabe der ID, der Bezeichnung sowie der Bezeichnung, welche auf dem Zeugnis erscheint, einem Statistik-Kürzel, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getReligionen(schema: string): Promise>; /** * Implementierung der GET-Methode getReligion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/religionen/{id : \d+} * * Liest die Daten der Religion zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Religion * - Mime-Type: application/json * - Rückgabe-Typ: ReligionEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Religion mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Religion */ getReligion(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchReligion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/religionen/{id : \d+} * * Passt die Religion-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Religion besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Religion-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Religion-Daten zu ändern. * Code 404: Keine Religion mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchReligion(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteReligionEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/religionen/{id : \d+} * * Entfernt einen Religion-Katalog-Eintrag der Schule. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Der Religion-Katalog-Eintrag wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: ReligionEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kein Religion-Katalog-Eintrag vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Religion-Katalog-Eintrag wurde erfolgreich entfernt. */ deleteReligionEintrag(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteReligionEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/religionen/delete/multiple * * Entfernt mehrere Religion-Katalog-Einträge der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Religion-Katalog-Einträge wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Religion-Katalog-Einträge nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Religion-Katalog-Einträge wurde erfolgreich entfernt. */ deleteReligionEintraege(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode createReligion für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/religionen/new * * Erstellt eine neue Religion und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Religion besitzt. * * Mögliche HTTP-Antworten: * Code 201: Religion wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: ReligionEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Religion anzulegen. * Code 404: Keine Religion mit dem eingegebenen Kuerzel gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Religion wurde erfolgreich angelegt. */ createReligion(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getKatalogSchuelerStatus für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schueler/status * * Die Liste der Einträge aus dem Katalog Schüler-Status. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen für den Katalog Schüler-Status * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen für den Katalog Schüler-Status */ getKatalogSchuelerStatus(schema: string): Promise>; /** * Implementierung der GET-Methode getSchulen für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen * * Erstellt eine Liste aller in dem schul-spezifischen Katalog vorhanden Schulen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getSchulen(schema: string): Promise>; /** * Implementierung der GET-Methode getSchuleAusKatalog für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen/{id : \d+} * * Gibt den Eintrag im schulspezifischen Katalog der Schulen zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Eintrag im schulspezifischen Katalog der Schulen * - Mime-Type: application/json * - Rückgabe-Typ: SchulEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Eintrag im schulspezifischen Katalog der Schulen */ getSchuleAusKatalog(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchSchuleAusKatalog für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen/{id : \d+} * * Passt den Eintrag des schulspezifischen Kataloges der Schulen mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Katalog-Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSchuleAusKatalog(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteSchuleVonKatalog für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen/{id : \d+} * * aus dem schulspezifischen Katalog der Schulen.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Der Eintrag wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: SchulEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kein Eintrag vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Eintrag wurde erfolgreich entfernt. */ deleteSchuleVonKatalog(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addSchuleZuKatalog für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen/create * * Erstellt einen neuen Eintrag für den schulspezifischen Katalog der Schulen und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Eintrag wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: SchulEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Eintrag für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Eintrag wurde erfolgreich hinzugefügt. */ addSchuleZuKatalog(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteSchulenVonKatalog für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen/delete/multiple * * Entfernt mehrere Einträge aus dem schulspezifischen Katalog der Schulen.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Einträge wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Räume nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Einträge wurde erfolgreich entfernt. */ deleteSchulenVonKatalog(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getSchulenMitKuerzel für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/schulen/kuerzel * * Erstellt eine Liste aller in dem schul-spezifischen Katalog vorhanden Schulen, welche ein Kürzel gesetzt haben. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getSchulenMitKuerzel(schema: string): Promise>; /** * Implementierung der GET-Methode getSchuleStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/stammdaten * * Liest die Stammdaten der Schule zum angegebenen Schema aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schuldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Stammdaten der Schule * - Mime-Type: application/json * - Rückgabe-Typ: SchuleStammdaten * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten anzusehen. * Code 404: Kein Eintrag mit dem angegebenen Schema gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Die Stammdaten der Schule */ getSchuleStammdaten(schema: string): Promise; /** * Implementierung der PATCH-Methode patchSchuleStammdaten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/stammdaten * * Passt die Schul-Stammdaten an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Schuldaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Schul-Stammdaten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schuldaten zu ändern. * Code 404: Kein Schüler-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchSchuleStammdaten(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getTelefonart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/telefonart/{id : \d+} * * Liest die Daten der Telefonart zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Telefonart * - Mime-Type: application/json * - Rückgabe-Typ: TelefonArt * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Telefonart mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Telefonart */ getTelefonart(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchTelefonart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/Telefonart/{id : \d+} * * Passt die Telefonart-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Telefonart besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Telefonart-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Telefonart-Daten zu ändern. * Code 404: Keine Telefonart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchTelefonart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addTelefonart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/telefonart/new * * Erstellt eine neue Telefonart und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Telefonart besitzt. * * Mögliche HTTP-Antworten: * Code 201: Telefonart wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: TelefonArt * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Telefonart anzulegen. * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Telefonart wurde erfolgreich angelegt. */ addTelefonart(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getTelefonarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/Telefonarten * * Erstellt eine Liste aller in dem Katalog vorhanden Telefonarten unter Angabe der ID und der Bezeichnung. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getTelefonarten(schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteTelefonarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/telefonarten/delete/multiple * * Entfernt mehrere Telefonarten der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Telefonarten wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Telefonarten nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Telefonarten wurden erfolgreich entfernt. */ deleteTelefonarten(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getSchuelerByVermerkartID für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkart/{vermerkart : \d+}/schuelerinfos * * Erstellt eine Liste aller Schüler der angegebenen Vermerkart unter Angabe der ID.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Schülerdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Schüler-Listen-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Schülerdaten anzusehen. * Code 404: Keine Schüler-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} vermerkart - der Pfad-Parameter vermerkart * * @returns Eine Liste von Schüler-Listen-Einträgen */ getSchuelerByVermerkartID(schema: string, vermerkart: number): Promise>; /** * Implementierung der GET-Methode getVermerkarten für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkarten * * Erstellt eine Liste aller in dem Katalog vorhanden Vermerkarten unter Angabe der ID, der Bezeichnung sowie der Bezeichnung, einer Sortierreihenfolge und ob sie in der Anwendung sichtbar bzw. änderbar sein sollen. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Katalog-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste von Katalog-Einträgen */ getVermerkarten(schema: string): Promise>; /** * Implementierung der GET-Methode getVermerkart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkarten/{id : \d+} * * Liest die Daten der Vermerkart zu der angegebenen ID aus der Datenbank und liefert diese zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogdaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten der Vermerkart * - Mime-Type: application/json * - Rückgabe-Typ: VermerkartEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalogdaten anzusehen. * Code 404: Keine Vermerkart mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten der Vermerkart */ getVermerkart(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchVermerkart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkarten/{id : \d+} * * Passt die Vermerkart-Stammdaten zu der angegebenen ID an und speichert das Ergebnis in der Datenbank. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern der Daten der Vermerkart besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in die Vermerkart-Daten integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um Vermerkart-Daten zu ändern. * Code 404: Keine Vermerkart mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchVermerkart(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteVermerkartEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkarten/{id : \d+} * * Entfernt einen Vermerkart-Katalog-Eintrag der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Der Vermerkart-Katalog-Eintrag wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: VermerkartEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kein Vermerkart-Katalog-Eintrag vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Vermerkart-Katalog-Eintrag wurde erfolgreich entfernt. */ deleteVermerkartEintrag(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteVermerkartEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkarten/delete/multiple * * Entfernt mehrere Vermerkart-Katalog-Einträge der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Vermerkart-Katalog-Einträge nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteVermerkartEintraege(data: List, schema: string): Promise>; /** * Implementierung der POST-Methode createVermerkart für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/vermerkarten/new * * Erstellt eine neue Vermerkart und gibt sie zurück.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen einer Vermerkart besitzt. * * Mögliche HTTP-Antworten: * Code 201: Vermerkart wurde erfolgreich angelegt. * - Mime-Type: application/json * - Rückgabe-Typ: VermerkartEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Vermerkart anzulegen. * Code 404: Keine Vermerkart mit dem eingegebenen Kuerzel gefunden * Code 409: Fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Vermerkart wurde erfolgreich angelegt. */ createVermerkart(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode getZeitraster für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster * * Gibt den Zeitraster-Katalog der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Zeitraster-Katalog der Schule. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine gültige Anmeldung. * Code 404: Keine Zeitraster-Einträge gefunden. * * @param {string} schema - der Pfad-Parameter schema * * @returns Der Zeitraster-Katalog der Schule. */ getZeitraster(schema: string): Promise>; /** * Implementierung der GET-Methode getZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/{id : \d+} * * Gibt den Zeitraster-Eintrag der Schule zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Katalogen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Zeitraster-Eintrag der Schule * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanZeitraster * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Katalog anzusehen. * Code 404: Kein Zeitraster-Eintrag bei der Schule gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Zeitraster-Eintrag der Schule */ getZeitrasterEintrag(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/{id : \d+} * * Passt den Zeitraster-Eintrag der Schule mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Katalog-Daten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchZeitrasterEintrag(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/{id : \d+} * * Entfernt einen Zeitraster-Eintrag der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Der Zeitraster-Eintrag wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanZeitraster * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Kein Zeitraster-Eintrag vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Zeitraster-Eintrag wurde erfolgreich entfernt. */ deleteZeitrasterEintrag(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/create * * Erstellt einen neue Zeitraster-Eintrag für die Schule und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Zeitraster-Eintrag wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanZeitraster * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Zeitraster-Eintrag für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Zeitraster-Eintrag wurde erfolgreich hinzugefügt. */ addZeitrasterEintrag(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addZeitrasterEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/create/multiple * * Erstellt neue Zeitraster-Einträge für die Schule und gibt die zugehörigen Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Katalogs besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenzeiten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Zeitraster-Einträge für die Schule anzulegen. * Code 404: Die Katalogdaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Pausenzeiten wurden erfolgreich hinzugefügt. */ addZeitrasterEintraege(data: List>, schema: string): Promise>; /** * Implementierung der DELETE-Methode deleteZeitrasterEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/delete/multiple * * Entfernt mehrere Zeitraster-Einträge der Schule.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten von Katalogen hat. * * Mögliche HTTP-Antworten: * Code 200: Die Zeitraster-Einträge wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Katalog zu bearbeiten. * Code 404: Zeitraster-Einträge nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Zeitraster-Einträge wurde erfolgreich entfernt. */ deleteZeitrasterEintraege(data: List, schema: string): Promise>; /** * Implementierung der PATCH-Methode patchZeitrasterEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/schule/zeitraster/patch/multiple * * Passt die Zeitrastereinträge an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag für mindestens eine der IDs der Daten gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchZeitrasterEintraege(data: List>, schema: string): Promise; /** * Implementierung der GET-Methode getSportbefreiungen für den Zugriff auf die URL https://{hostname}/db/{schema}/sportbefreiungen * * Gibt die Sportbefreiungen zurück, insofern der SVWS-Benutzer die erforderliche Berechtigung besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Sportbefreiungen. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Katalog-Einträge anzusehen. * Code 404: Keine Katalog-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Sportbefreiungen. */ getSportbefreiungen(schema: string): Promise>; /** * Implementierung der PATCH-Methode patchSportbefreiung für den Zugriff auf die URL https://{hostname}/db/{schema}/sportbefreiungen/{id : \d+} * * Patched die Sportbefreiung mit der angegebenen ID, insofern die notwendigen Berechtigungen vorliegen. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z. B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchSportbefreiung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addSportbefreiung für den Zugriff auf die URL https://{hostname}/db/{schema}/sportbefreiungen/create * * Erstellt eine neue Sportbefreiung, insofern die notwendigen Berechtigungen vorliegen * * Mögliche HTTP-Antworten: * Code 201: Die Sportbefreiung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: Sportbefreiung * Code 403: Der SVWS-Benutzer hat keine Rechte, um Sportbefreiung anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Sportbefreiung wurde erfolgreich hinzugefügt. */ addSportbefreiung(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteSportbefreiungen für den Zugriff auf die URL https://{hostname}/db/{schema}/sportbefreiungen/delete/multiple * * Entfernt mehrere Sportbefreiungen, insofern die notwendigen Berechtigungen vorhanden sind. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Sportbefreiungen zu entfernen. * Code 404: Sportbefreiungen nicht vorhanden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteSportbefreiungen(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+} * * Gibt die grundlegenden Daten des Stundeplans mit der angegebenen ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten des Stundenplans * - Mime-Type: application/json * - Rückgabe-Typ: Stundenplan * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen. * Code 404: Keine Stundenplandaten gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten des Stundenplans */ getStundenplan(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+} * * Passt die Stundenplandaten des Stundenplans mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplan(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+} * * Entfernt einen Stundenplan.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen des Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 204: Der Stundenplan wurde erfolgreich entfernt. * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu entfernen. * Code 404: Der Stundenplan ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ deleteStundenplan(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/aufsichtsbereiche/create * * Erstellt einen neuen Aufsichtsbereich für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Aufsichtsbereich wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanAufsichtsbereich * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Raum für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Aufsichtsbereich wurde erfolgreich hinzugefügt. */ addStundenplanAufsichtsbereich(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanAufsichtsbereiche für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/aufsichtsbereiche/create/multiple * * Erstellt mehrere neue Aufsichtsbereiche für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Aufsichtsbereiche wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Aufsichtsbereiche für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Aufsichtsbereiche wurden erfolgreich hinzugefügt. */ addStundenplanAufsichtsbereiche(data: List>, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanAufsichtsbereiche für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/aufsichtsbereiche/delete/multiple * * Entfernt mehrere Aufsichtsbereiche eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Aufsichtsbereiche wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Aufsichtsbereich nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Aufsichtsbereiche wurde erfolgreich entfernt. */ deleteStundenplanAufsichtsbereiche(data: List, schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addStundenplanKalenderwochenzuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/kalenderwochen/create * * Erstellt eine neue Kalenderwochenzuordnung für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Kalenderwochenzuordnung wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanKalenderwochenzuordnung * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Kalenderwochenzuordnung für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Kalenderwochenzuordnung wurde erfolgreich hinzugefügt. */ addStundenplanKalenderwochenzuordnung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanKalenderwochenzuordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/kalenderwochen/create/multiple * * Erstellt mehrere neue Kalenderwochenzuordnungen für den angegebenen Stundenplan und gibt die zugehörigen Objekte zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Kalenderwochenzuordnungen wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Kalenderwochenzuordnungen für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Kalenderwochenzuordnungen wurden erfolgreich hinzugefügt. */ addStundenplanKalenderwochenzuordnungen(data: List>, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanKalenderwochenzuordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/kalenderwochen/delete/multiple * * Entfernt mehrere Kalenderwochenzuordnungen eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Kalenderwochenzuordnungen wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Mindestens eine Kalenderwochenzuordnung ist nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Kalenderwochenzuordnungen wurde erfolgreich entfernt. */ deleteStundenplanKalenderwochenzuordnungen(data: List, schema: string, id: number): Promise>; /** * Implementierung der PATCH-Methode patchStundenplanKalenderwochenzuordnungen für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/kalenderwochen/patch/multiple * * Passt die Kalenderwochen-Zuordnungen eines Stundenplans an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag für mindestens eine der IDs der Daten gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanKalenderwochenzuordnungen(data: List>, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanPausenaufsicht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenaufsicht/create * * Erstellt eine neue Pausenaufsicht für die angebene Pausenzeit eines Stundenplans und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenaufsicht wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenaufsicht * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Pausenaufsicht für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenaufsicht wurde erfolgreich hinzugefügt. */ addStundenplanPausenaufsicht(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanPausenaufsichten für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenaufsicht/create/multiple * * Erstellt neue Pausenaufsichten für einen Stundenplan und gibt die zugehörigen Objekte zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenaufsichten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Pausenaufsichten für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenaufsichten wurden erfolgreich hinzugefügt. */ addStundenplanPausenaufsichten(data: List>, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanPausenaufsichten für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenaufsicht/delete/multiple * * Entfernt mehrere Pausenaufsichten eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenaufsichten wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Pausenaufsicht nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenaufsichten wurde erfolgreich entfernt. */ deleteStundenplanPausenaufsichten(data: List, schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getStundenplanPausenaufsichten für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenaufsichten * * Gibt die Pausenaufsichten des Stundeplans mit der angegebenen ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenaufsichten des Stundenplans * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen. * Code 404: Keine Stundenplandaten gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenaufsichten des Stundenplans */ getStundenplanPausenaufsichten(schema: string, id: number): Promise>; /** * Implementierung der POST-Methode updateStundenplanPausenaufsichtenBereiche für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenaufsichtenbereiche/update * * Entfernt und fügt mehrere Zuordungen von Pausenaufsichten zu Aufsichtsbereichen ggf. in Abhängigkeit von einem Wochentyp hinzu. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Entfernen und Hinzufügen besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Zuordnungen wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Zuordnungen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Zuordnungen zu löschen oder hinzufügen. * Code 404: Ein Wert für das Erstellen der Zuordnungen wurde nicht gefunden. * * @param {StundenplanPausenaufsichtBereichUpdate} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Zuordnungen wurden erfolgreich gelöscht bzw. hinzugefügt. Das Ergebnis beinhaltet die erstellten Zuordnungen */ updateStundenplanPausenaufsichtenBereiche(data: StundenplanPausenaufsichtBereichUpdate, schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addStundenplanPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenzeiten/create * * Erstellt eine neue Pausenzeit für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenzeit wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenzeit * Code 403: Der SVWS-Benutzer hat keine Rechte, um eine Pausenzeit für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeit wurde erfolgreich hinzugefügt. */ addStundenplanPausenzeit(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanPausenzeiten für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenzeiten/create/multiple * * Erstellt mehrere neue Pausenzeiten für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Pausenzeiten wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Pausenzeiten für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeiten wurden erfolgreich hinzugefügt. */ addStundenplanPausenzeiten(data: List>, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanPausenzeiten für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/pausenzeiten/delete/multiple * * Entfernt mehrere Pausenzeiten eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenzeiten wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Pausenzeit nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeiten wurde erfolgreich entfernt. */ deleteStundenplanPausenzeiten(data: List, schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addStundenplanRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/raeume/create * * Erstellt einen neuen Raum für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Raum wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanRaum * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Raum für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Raum wurde erfolgreich hinzugefügt. */ addStundenplanRaum(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanRaeume für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/raeume/create/multiple * * Erstellt mehrere neue Räume für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Räume wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Räume für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Räume wurden erfolgreich hinzugefügt. */ addStundenplanRaeume(data: List>, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanRaeume für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/raeume/delete/multiple * * Entfernt mehrere Räume eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Räume wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Raum nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Räume wurde erfolgreich entfernt. */ deleteStundenplanRaeume(data: List, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanUnterrichte für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/unterricht/delete/multiple * * Entfernt mehrere Unterrichte eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Unterrichte wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Unterricht nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Unterrichte wurde erfolgreich entfernt. */ deleteStundenplanUnterrichte(data: List, schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getStundenplanUnterrichte für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/unterrichte * * Gibt die Unterrichte des Stundeplans mit der angegebenen ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Unterrichte des Stundenplans * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen. * Code 404: Keine Stundenplandaten gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Unterrichte des Stundenplans */ getStundenplanUnterrichte(schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getStundenplanUnterrichtsverteilung für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/unterrichtsverteilung * * Gibt die Daten zur Unterrichtsverteilung des Stundenplans mit der angegebenen ID zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Daten zur Unterrichtsverteilung des Stundenplans * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanUnterrichtsverteilung * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Stundenplandaten anzusehen. * Code 404: Keine Stundenplandaten gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Daten zur Unterrichtsverteilung des Stundenplans */ getStundenplanUnterrichtsverteilung(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getStundenplanZeitraster für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/zeitraster * * Erstellt eine Liste der Einträge aus dem Zeitraster des angegebenen Stundeplans. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste von Zeitraster-Einträgen * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um das Zeitraster anzusehen. * Code 404: Keine Zeitraster-Einträge gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Eine Liste von Zeitraster-Einträgen */ getStundenplanZeitraster(schema: string, id: number): Promise>; /** * Implementierung der POST-Methode addStundenplanZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/zeitraster/create * * Erstellt einen neuen Zeitrastereintrag für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Zeitrastereintrag wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanZeitraster * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Zeitrastereintrag für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Zeitrastereintrag wurde erfolgreich hinzugefügt. */ addStundenplanZeitrasterEintrag(data: Partial, schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanZeitrasterEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/zeitraster/create/multiple * * Erstellt mehrere neue Zeitrastereinträge für den angegebenen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Zeitrastereinträge wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Zeitrastereinträge für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Zeitrastereinträge wurden erfolgreich hinzugefügt. */ addStundenplanZeitrasterEintraege(data: List>, schema: string, id: number): Promise>; /** * Implementierung der DELETE-Methode deleteStundenplanZeitrasterEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{id : \d+}/zeitraster/delete/multiple * * Entfernt mehrere Zeitrastereinträge eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Zeitrastereinträge wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Kein Zeitrastereintrag vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Zeitrastereinträge wurde erfolgreich entfernt. */ deleteStundenplanZeitrasterEintraege(data: List, schema: string, id: number): Promise>; /** * Implementierung der GET-Methode getStundenplanLehrer für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{idStundenplan : \d+}/lehrer/{id : \d+} * * Gibt den Lehrer eines Stundenplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Lehrer * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanLehrer * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Kein Raum eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} idStundenplan - der Pfad-Parameter idStundenplan * @param {number} id - der Pfad-Parameter id * * @returns Der Lehrer */ getStundenplanLehrer(schema: string, idStundenplan: number, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanPausenaufsicht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/{idStundenplan : \d+}/pausenaufsicht/{id : \d+} * * Passt die Pausenaufsicht mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} idStundenplan - der Pfad-Parameter idStundenplan * @param {number} id - der Pfad-Parameter id */ patchStundenplanPausenaufsicht(data: Partial, schema: string, idStundenplan: number, id: number): Promise; /** * Implementierung der GET-Methode getStundenplanlisteAktivFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/aktiv/liste/{abschnitt : \d+} * * Erstellt eine Liste der aktiven Stundenpläne des angegebenen Schuljahresabschnitts. Die Stundenpläne sind anhand der Gültigkeit sortiert.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplanlisten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der aktiven Stundenpläne * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Stundenplanlisten anzusehen. * Code 404: Keine Stundenpläne gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Eine Liste der aktiven Stundenpläne */ getStundenplanlisteAktivFuerAbschnitt(schema: string, abschnitt: number): Promise>; /** * Implementierung der GET-Methode getStundenplanAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/aufsichtsbereich/{id : \d+} * * Gibt den Aufsichtsbereich eines Stundenplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Raum * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanAufsichtsbereich * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Kein Aufsichtsbereich eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Raum */ getStundenplanAufsichtsbereich(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/aufsichtsbereich/{id : \d+} * * Passt den Aufsichtsbereich mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanAufsichtsbereich(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanAufsichtsbereich für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/aufsichtsbereiche/{id : \d+} * * Entfernt einen Aufsichtsbereich eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Der Aufsichtsbereich wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanAufsichtsbereich * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Kein Aufsichtsbereich vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Aufsichtsbereich wurde erfolgreich entfernt. */ deleteStundenplanAufsichtsbereich(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/create * * Erstellt einen neuen Stundenplan und gibt die zugehörigen Daten zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Erstellen eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Stundenplan wurde erfolgreich erstellt. * - Mime-Type: application/json * - Rückgabe-Typ: Stundenplan * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan anzulegen. * Code 404: Benötigte Daten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Stundenplan wurde erfolgreich erstellt. */ addStundenplan(data: Partial, schema: string): Promise; /** * Implementierung der DELETE-Methode deleteStundenplaene für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/delete/multiple * * Entfernt mehrere Stundenpläne. Dabei wird geprüft, ob alle Vorbedingungen zum Entfernender Stundenpläne erfüllt sind und der SVWS-Benutzer die notwendige Berechtigung hat. * * Mögliche HTTP-Antworten: * Code 200: Die Lösch-Operationen wurden ausgeführt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Stundenpläne zu entfernen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Lösch-Operationen wurden ausgeführt. */ deleteStundenplaene(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getStundenplanKalenderwochenzuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/kalenderwochen/{id : \d+} * * Gibt die Kalenderwochen-Zuordnung eines Stundeplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Kalenderwochen-Zuordnung * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanKalenderwochenzuordnung * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keine Kalenderwochen-Zuordnung eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Kalenderwochen-Zuordnung */ getStundenplanKalenderwochenzuordnung(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanKalenderwochenzuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/kalenderwochen/{id : \d+} * * Passt die Kalenderwochen-Zuordnung mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanKalenderwochenzuordnung(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanKalenderwochenzuordnung für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/kalenderwochen/{id : \d+} * * Entfernt eine Kalenderwochenzuordnung eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Kalenderwochenzuordnung wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanKalenderwochenzuordnung * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Keine Kalenderwochenzuordnung vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Kalenderwochenzuordnung wurde erfolgreich entfernt. */ deleteStundenplanKalenderwochenzuordnung(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getStundenplanliste für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/liste * * Erstellt eine Liste der Stundenpläne. Die Stundenpläne sind anhand des Schuljahresabschnitt und der Gültigkeit sortiert.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplanlisten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Stundenpläne * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Stundenplanlisten anzusehen. * Code 404: Keine Stundenpläne gefunden * - Mime-Type: text/plain * - Rückgabe-Typ: String * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste der Stundenpläne */ getStundenplanliste(schema: string): Promise>; /** * Implementierung der GET-Methode getStundenplanlisteFuerAbschnitt für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/liste/{abschnitt : \d+} * * Erstellt eine Liste der Stundenpläne des angegebenen Schuljahresabschnitts. Die Stundenpläne sind anhand der Gültigkeit sortiert.Es wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplanlisten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste der Stundenpläne * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Stundenplanlisten anzusehen. * Code 404: Keine Stundenpläne gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} abschnitt - der Pfad-Parameter abschnitt * * @returns Eine Liste der Stundenpläne */ getStundenplanlisteFuerAbschnitt(schema: string, abschnitt: number): Promise>; /** * Implementierung der GET-Methode getStundenplanPausenaufsicht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/pausenaufsicht/{id : \d+} * * Gibt eine Pausenaufsicht eines Stundeplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenaufsicht * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenaufsicht * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keine Pausenaufsicht eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenaufsicht */ getStundenplanPausenaufsicht(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanPausenaufsicht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/pausenaufsicht/{id : \d+} * * Entfernt eine Pausenaufsicht eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenaufsicht wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenaufsicht * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Keine Pausenaufsicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenaufsicht wurde erfolgreich entfernt. */ deleteStundenplanPausenaufsicht(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getStundenplanPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/pausenzeiten/{id : \d+} * * Gibt die Pausenzeit eines Stundenplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenzeit * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenzeit * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keine Pausenzeit eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeit */ getStundenplanPausenzeit(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/pausenzeiten/{id : \d+} * * Passt die Pausenzeit mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanPausenzeit(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanPausenzeit für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/pausenzeiten/{id : \d+} * * Entfernt eine Pausenzeit eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Die Pausenzeit wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanPausenzeit * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Keine Pausenzeit vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Pausenzeit wurde erfolgreich entfernt. */ deleteStundenplanPausenzeit(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getKlassenStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/plaene/{id : \d+}/klasse/{klasse_id : \d+} * * Erstellt den angebebenen Stundeplan in Bezug auf die angegebene Klasse. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Klassen-Stundenplan * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanKomplett * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keinen Stundenplan gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} klasse_id - der Pfad-Parameter klasse_id * * @returns Der Klassen-Stundenplan */ getKlassenStundenplan(schema: string, id: number, klasse_id: number): Promise; /** * Implementierung der GET-Methode getLehrerStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/plaene/{id : \d+}/lehrer/{lehrer_id : \d+} * * Erstellt den angebebenen Stundeplan in Bezug auf den angegebenen Lehrer. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Lehrer-Stundenplan * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanKomplett * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keinen Stundenplan gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} lehrer_id - der Pfad-Parameter lehrer_id * * @returns Der Lehrer-Stundenplan */ getLehrerStundenplan(schema: string, id: number, lehrer_id: number): Promise; /** * Implementierung der GET-Methode getSchuelerStundenplan für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/plaene/{id : \d+}/schueler/{schueler_id : \d+} * * Erstellt den angebebenen Stundeplan in Bezug auf den angegebenen Schüler. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Schüler-Stundenplan * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanKomplett * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keinen Stundenplan gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * @param {number} schueler_id - der Pfad-Parameter schueler_id * * @returns Der Schüler-Stundenplan */ getSchuelerStundenplan(schema: string, id: number, schueler_id: number): Promise; /** * Implementierung der GET-Methode getStundenplanRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/raeume/{id : \d+} * * Gibt den Raum eines Stundenplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Raum * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanRaum * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Kein Raum eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Raum */ getStundenplanRaum(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/raeume/{id : \d+} * * Passt den Raum mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanRaum(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanRaum für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/raeume/{id : \d+} * * Entfernt einen Raum eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Der Raum wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanRaum * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Kein Raum vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Raum wurde erfolgreich entfernt. */ deleteStundenplanRaum(schema: string, id: number): Promise; /** * Implementierung der GET-Methode getStundenplanSchiene für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/schienen/{id : \d+} * * Gibt die Schiene eines Stundeplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Die Schiene * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanSchiene * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Keine Schiene eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Die Schiene */ getStundenplanSchiene(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanSchiene für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/schienen/{id : \d+} * * Passt die Schiene mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanSchiene(data: Partial, schema: string, id: number): Promise; /** * Implementierung der GET-Methode getStundenplanUnterricht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/unterricht/{id : \d+} * * Gibt einen Unterricht eines Stundeplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Unterricht * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanUnterricht * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Kein Unterricht eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Unterricht */ getStundenplanUnterricht(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanUnterricht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/unterricht/{id : \d+} * * Passt den Unterricht mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanUnterricht(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanUnterricht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/unterricht/{id : \d+} * * Entfernt einen Unterricht eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Der Unterricht wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanUnterricht * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Kein Unterricht mit der ID vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Unterricht wurde erfolgreich entfernt. */ deleteStundenplanUnterricht(schema: string, id: number): Promise; /** * Implementierung der POST-Methode addStundenplanUnterricht für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/unterricht/create * * Erstellt einen neue Unterricht für einen Stundenplan und gibt das zugehörige Objekt zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Der Unterricht wurde erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanUnterricht * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Unterricht für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Unterricht wurde erfolgreich hinzugefügt. */ addStundenplanUnterricht(data: Partial, schema: string): Promise; /** * Implementierung der POST-Methode addStundenplanUnterrichte für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/unterricht/create/multiple * * Erstellt neue Unterrichte für einen Stundenplan und gibt die zugehörigen Objekte zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans besitzt. * * Mögliche HTTP-Antworten: * Code 201: Die Unterrichte wurden erfolgreich hinzugefügt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um Unterrichte für einen Stundenplan anzulegen. * Code 404: Die Stundenplandaten wurden nicht gefunden * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Unterrichte wurden erfolgreich hinzugefügt. */ addStundenplanUnterrichte(data: List>, schema: string): Promise>; /** * Implementierung der PATCH-Methode patchStundenplanUnterrichte für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/unterricht/patch/multiple * * Passt die Unterrichte an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag für mindestens eine der IDs der Daten gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchStundenplanUnterrichte(data: List>, schema: string): Promise; /** * Implementierung der GET-Methode getStundenplanZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/zeitraster/{id : \d+} * * Gibt den Zeitraster-Eintrag eines Stundeplans zurück. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ansehen von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Zeitraster-Eintrag * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanZeitraster * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Stundenplan anzusehen. * Code 404: Kein Zeitraster-Eintrag eines Stundenplans gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Zeitraster-Eintrag */ getStundenplanZeitrasterEintrag(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/zeitraster/{id : \d+} * * Passt den Zeitrastereintrag mit der angebenen ID an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchStundenplanZeitrasterEintrag(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteStundenplanZeitrasterEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/zeitraster/{id : \d+} * * Entfernt einen Zeitrastereintrag eines Stundenplans.Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Bearbeiten eines Stundenplans hat. * * Mögliche HTTP-Antworten: * Code 200: Der Zeitrastereintrag wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: StundenplanZeitraster * Code 403: Der SVWS-Benutzer hat keine Rechte, um einen Stundenplan zu bearbeiten. * Code 404: Kein Zeitrastereintrag vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Zeitrastereintrag wurde erfolgreich entfernt. */ deleteStundenplanZeitrasterEintrag(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchStundenplanZeitrasterEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/stundenplan/zeitraster/patch/multiple * * Passt die Zeitrastereinträge an. Dabei wird geprüft, ob der SVWS-Benutzer die notwendige Berechtigung zum Ändern von Stundenplandaten besitzt. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Daten zu ändern. * Code 404: Kein Eintrag für mindestens eine der IDs der Daten gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List>} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema */ patchStundenplanZeitrasterEintraege(data: List>, schema: string): Promise; /** * Implementierung der GET-Methode getWiedervorlageEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/{id : \d+} * * Liefert zu der ID den zugehörigen Wiedervorlage-Eintrag. Dabei wird geprüft, ob der Benutzer auf den Eintrag zugreifen darf. * * Mögliche HTTP-Antworten: * Code 200: Der Wiedervorlage-Eintrag * - Mime-Type: application/json * - Rückgabe-Typ: WiedervorlageEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um den WiedervorlageEintrag anzusehen. * Code 404: Kein WiedervorlageEintrag mit der angegebenen ID gefunden * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Wiedervorlage-Eintrag */ getWiedervorlageEintrag(schema: string, id: number): Promise; /** * Implementierung der PATCH-Methode patchWiedervorlageEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/{id : \d+} * * Passt den Wiedervorlage-Eintrag mit der angegebenen ID an. Dabei wird geprüft, ob der Benutzer auf den Eintrag zugreifen darf. * * Mögliche HTTP-Antworten: * Code 200: Der Patch wurde erfolgreich in den Wiedervorlage-Eintrag integriert. * Code 400: Der Patch ist fehlerhaft aufgebaut. * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Wiedervorlage-Eintrag zu ändern. * Code 404: Kein Wiedervorlage-Eintrag mit der angegebenen ID gefunden * Code 409: Der Patch ist fehlerhaft, da zumindest eine Rahmenbedingung für einen Wert nicht erfüllt wurde (z.B. eine negative ID) * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id */ patchWiedervorlageEintrag(data: Partial, schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteWiedervorlageEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/{id : \d+} * * Entfernt einen Wiedervorlage-Eintrag. Dabei wird geprüft, ob der Benutzer auf den Eintrag zugreifen darf. * * Mögliche HTTP-Antworten: * Code 200: Der Wiedervorlage-Eintrag wurde erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: WiedervorlageEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um dem Wiedervorlage-Eintrag zu löschen. * Code 404: Kein Wiedervorlage-Eintrag mit der angegebenen ID gefunden. * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Wiedervorlage-Eintrag wurde erfolgreich entfernt. */ deleteWiedervorlageEintrag(schema: string, id: number): Promise; /** * Implementierung der POST-Methode setWiedervorlageEintragErledigt für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/{id : \d+}/erledigt * * Markiert den Wiedervorlage-Eintrag mit der angegebenen ID als erledigt.Dabei wird geprüft, ob der Benutzer auf den Eintrag zugreifen darf. * * Mögliche HTTP-Antworten: * Code 201: Der Wiedervorlage-Eintrag * - Mime-Type: application/json * - Rückgabe-Typ: WiedervorlageEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Wiedervorlage-Eintrag als erledigt zu markieren. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {string} schema - der Pfad-Parameter schema * @param {number} id - der Pfad-Parameter id * * @returns Der Wiedervorlage-Eintrag */ setWiedervorlageEintragErledigt(schema: string, id: number): Promise; /** * Implementierung der DELETE-Methode deleteWiedervorlageEintraege für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/delete/multiple * * Entfernt mehrere Wiedervorlage-Einträge. Dabei wird geprüft, ob der Benutzer auf die Einträge zugreifen darf. * * Mögliche HTTP-Antworten: * Code 200: Die Wiedervorlage-Einträge wurden erfolgreich entfernt. * - Mime-Type: application/json * - Rückgabe-Typ: List * Code 403: Der SVWS-Benutzer hat keine Rechte, um die Wiedervorlage-Einträge zu entfernen. * Code 404: Wiedervorlage-Eintrag nicht vorhanden * Code 409: Die übergebenen Daten sind fehlerhaft * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {List} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Die Wiedervorlage-Einträge wurden erfolgreich entfernt. */ deleteWiedervorlageEintraege(data: List, schema: string): Promise>; /** * Implementierung der GET-Methode getWiedervorlageListe für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/liste * * Gibt die Liste der Wiedervorlage des angemeldeteten Benutzers zurück. Dabei werden auch die Einträge berücksichtigt, wo der angemeldete Benutzer in einer zugeordeten Benutzergruppe des Wiedervorlage-Eintrags enthalten ist. * * Mögliche HTTP-Antworten: * Code 200: Eine Liste mit den Einträgen der Wiedervorlage. * - Mime-Type: application/json * - Rückgabe-Typ: List * * @param {string} schema - der Pfad-Parameter schema * * @returns Eine Liste mit den Einträgen der Wiedervorlage. */ getWiedervorlageListe(schema: string): Promise>; /** * Implementierung der POST-Methode addWiedervorlageEintrag für den Zugriff auf die URL https://{hostname}/db/{schema}/wiedervorlage/neu * * Erstellt einen Wiedervorlage-Eintrag. * * Mögliche HTTP-Antworten: * Code 201: Der Wiedervorlage-Eintrag * - Mime-Type: application/json * - Rückgabe-Typ: WiedervorlageEintrag * Code 403: Der SVWS-Benutzer hat keine Rechte, um den Wiedervorlage-Eintrag anzulegen. * Code 500: Unspezifizierter Fehler (z.B. beim Datenbankzugriff) * * @param {Partial} data - der Request-Body für die HTTP-Methode * @param {string} schema - der Pfad-Parameter schema * * @returns Der Wiedervorlage-Eintrag */ addWiedervorlageEintrag(data: Partial, schema: string): Promise; /** * Implementierung der GET-Methode isAlive für den Zugriff auf die URL https://{hostname}/status/alive * * Eine Test-Methode zum Prüfen, ob der Server erreichbar ist. * * Mögliche HTTP-Antworten: * Code 200: Der Server ist erreichbar! * - Mime-Type: text/plain * - Rückgabe-Typ: String * * @returns Der Server ist erreichbar! */ isAlive(): Promise; /** * Implementierung der GET-Methode isAlivePrivileged für den Zugriff auf die URL https://{hostname}/status/alive/privileged * * Eine Test-Methode zum Prüfen, ob die Privileged-API des Serves erreichbar ist oder nicht. * * Mögliche HTTP-Antworten: * Code 200: Der Server ist über die Privileged API erreichbar! * - Mime-Type: application/json * - Rückgabe-Typ: Boolean * * @returns Der Server ist über die Privileged API erreichbar! */ isAlivePrivileged(): Promise; /** * Implementierung der GET-Methode getServerDBRevision für den Zugriff auf die URL https://{hostname}/status/db/revision * * Gibt Datenbank-Revision zurück, welche der SVWS-Server unterstützt. * * Mögliche HTTP-Antworten: * Code 200: Die Datenbank-Revision * - Mime-Type: application/json * - Rückgabe-Typ: Long * * @returns Die Datenbank-Revision */ getServerDBRevision(): Promise; /** * Implementierung der GET-Methode getServerModus für den Zugriff auf die URL https://{hostname}/status/mode * * Gibt den Betriebsmodus (stable, alpha, beta oder dev) des SVWS-Servers zurück. * * Mögliche HTTP-Antworten: * Code 200: Der Betriebsmodus (stable, alpha, beta oder dev) * - Mime-Type: application/json * - Rückgabe-Typ: String * * @returns Der Betriebsmodus (stable, alpha, beta oder dev) */ getServerModus(): Promise; /** * Implementierung der GET-Methode getSchildMinVersion für den Zugriff auf die URL https://{hostname}/status/schild/minversion * * Gibt die erste kompatible Schild-Version zurück. * * Mögliche HTTP-Antworten: * Code 200: Die erste kompatible Schild-Version * - Mime-Type: application/json * - Rückgabe-Typ: String * * @returns Die erste kompatible Schild-Version */ getSchildMinVersion(): Promise; /** * Implementierung der GET-Methode getServerVersion für den Zugriff auf die URL https://{hostname}/status/version * * Gibt die Version des SVWS-Servers zurück. * * Mögliche HTTP-Antworten: * Code 200: Die SVWS-Server-Version * - Mime-Type: application/json * - Rückgabe-Typ: String * * @returns Die SVWS-Server-Version */ getServerVersion(): Promise; } //# sourceMappingURL=ApiServer.d.ts.map