Untis-API: Fehlzeiten abgleich
This commit is contained in:
@@ -15,6 +15,7 @@ public sealed class WebUntisClient : IAsyncDisposable
|
||||
private readonly SemaphoreSlim _sessionGate = new(1, 1);
|
||||
private readonly Timer _sessionExpiryTimer;
|
||||
private string? _sessionId;
|
||||
private int? _myTeacherUntisId;
|
||||
private DateTimeOffset _sessionExpiresAt;
|
||||
private int _activeRequests;
|
||||
private bool _disposed;
|
||||
@@ -114,7 +115,8 @@ public sealed class WebUntisClient : IAsyncDisposable
|
||||
public Task<UntisStudentReport> GetStudentReportAsync(string? classNameFilter,
|
||||
CancellationToken cancellationToken) => WithSessionAsync(async sessionId =>
|
||||
{
|
||||
var reportData = await RequestReportAsync(sessionId, cancellationToken)
|
||||
var reportData = await RequestReportAsync(sessionId,
|
||||
"name=Student&format=csv&klasseId=-1&studentsForDate=true&context=klasseId", cancellationToken)
|
||||
?? await PollReportAsync(sessionId, cancellationToken);
|
||||
var reportText = await FetchReportTextAsync(sessionId, reportData, cancellationToken);
|
||||
var allStudents = WebUntisStudentReportParser.Parse(reportText);
|
||||
@@ -126,6 +128,26 @@ public sealed class WebUntisClient : IAsyncDisposable
|
||||
return new UntisStudentReport(students.Count, normalizedFilter, students);
|
||||
}, cancellationToken);
|
||||
|
||||
// Undokumentierter interner Bericht der WebUntis-WebApp (Unterricht -> Berichte zum Unterricht ->
|
||||
// "Fehlzeiten pro Unterricht pro Schüler*in"). lessonId entspricht der lsid, die pro Schuljahr neu
|
||||
// vergeben wird (WebUntis-interne Unterrichtsnummer) und deshalb pro Lerngruppe gepflegt werden muss;
|
||||
// eine JSON-RPC-Methode dafür existiert nicht. teacherId ist dagegen immer die eigene Lehrkraft-Kennung
|
||||
// aus der Session — der Bericht zeigt ohnehin nur eigenen Unterricht, auch bei Doppelbesetzung.
|
||||
public Task<IReadOnlyList<UntisLessonAbsence>> GetLessonAbsencesAsync(int lessonId,
|
||||
int startDate, int endDate, CancellationToken cancellationToken) => WithSessionAsync(async sessionId =>
|
||||
{
|
||||
var teacherId = _myTeacherUntisId
|
||||
?? throw new WebUntisException("WebUntis hat keine Lehrer-Kennung (personId) für diese Sitzung geliefert.");
|
||||
var query = "name=AbsencePerLesson&format=csv" +
|
||||
$"&lsid={lessonId}&lessonId={lessonId}&teacherId={teacherId}&reportElementType=2" +
|
||||
"&_withoutPageBreaks=on&_empty=on&_usingMarkNames=on" +
|
||||
$"&rpt_sd={startDate}&rpt_ed={endDate}&rpt_syid=-1&rpt_drdtype=CUSTOM";
|
||||
var reportData = await RequestReportAsync(sessionId, query, cancellationToken)
|
||||
?? await PollReportAsync(sessionId, cancellationToken);
|
||||
var reportText = await FetchReportTextAsync(sessionId, reportData, cancellationToken);
|
||||
return WebUntisLessonAbsenceParser.Parse(reportText);
|
||||
}, cancellationToken);
|
||||
|
||||
public Task<IReadOnlyList<UntisSubstitution>> GetSubstitutionsAsync(int startDate, int endDate,
|
||||
int? departmentId, CancellationToken cancellationToken) => WithSessionAsync(async sessionId =>
|
||||
{
|
||||
@@ -178,35 +200,6 @@ public sealed class WebUntisClient : IAsyncDisposable
|
||||
Entities(entry, "ro"), entry.Clone())).ToList();
|
||||
}, cancellationToken);
|
||||
|
||||
public Task<IReadOnlyList<UntisStudentAbsence>> GetAbsencesAsync(int startDate, int endDate,
|
||||
CancellationToken cancellationToken) => WithSessionAsync(async sessionId =>
|
||||
{
|
||||
var result = await RpcAsync("getTimetableWithAbsences", new
|
||||
{
|
||||
options = new { startDate, endDate },
|
||||
}, sessionId, cancellationToken);
|
||||
if (!TryProperty(result, "periodsWithAbsences", out var periods) || periods.ValueKind != JsonValueKind.Array)
|
||||
throw new WebUntisException("WebUntis hat keine gültigen Fehlzeiten-Daten geliefert.");
|
||||
|
||||
return (IReadOnlyList<UntisStudentAbsence>)periods.EnumerateArray()
|
||||
.Select(entry => new UntisStudentAbsence(
|
||||
RequiredInt(entry, "studentId"),
|
||||
RequiredInt(entry, "date"),
|
||||
RequiredInt(entry, "startTime"),
|
||||
RequiredInt(entry, "endTime"),
|
||||
OptionalInt(entry, "absentTime") ?? 0,
|
||||
OptionalBoolean(entry, "checked"),
|
||||
OptionalString(entry, "absenceReason"),
|
||||
OptionalString(entry, "excuseStatus"),
|
||||
OptionalInt(entry, "subjectId"),
|
||||
IntArray(entry, "teacherIds"),
|
||||
OptionalString(entry, "studentGroup"),
|
||||
entry.Clone()))
|
||||
.OrderBy(entry => entry.Date)
|
||||
.ThenBy(entry => entry.StartTime)
|
||||
.ToList();
|
||||
}, cancellationToken);
|
||||
|
||||
public Task<IReadOnlyList<UntisClassRegisterEntry>> GetClassRegisterEntriesAsync(int studentId,
|
||||
int startDate, int endDate, CancellationToken cancellationToken) => WithSessionAsync(async sessionId =>
|
||||
{
|
||||
@@ -287,6 +280,7 @@ public sealed class WebUntisClient : IAsyncDisposable
|
||||
$"WebUntis-Login fehlgeschlagen: {configuration.Host} hat für die Schulkennung " +
|
||||
$"„{configuration.School}“ keine Sitzung geliefert. Bitte insbesondere Server und " +
|
||||
"Schulkennung mit der WebUntis-Anmeldeseite vergleichen.");
|
||||
_myTeacherUntisId = OptionalInt(result, "personId");
|
||||
}
|
||||
|
||||
_activeRequests++;
|
||||
@@ -398,10 +392,10 @@ public sealed class WebUntisClient : IAsyncDisposable
|
||||
return result.Clone();
|
||||
}
|
||||
|
||||
private async Task<ReportData?> RequestReportAsync(string sessionId, CancellationToken cancellationToken)
|
||||
private async Task<ReportData?> RequestReportAsync(string sessionId, string query,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var uri = $"https://{GetConfiguration().Host}/WebUntis/reports.do" +
|
||||
"?name=Student&format=csv&klasseId=-1&studentsForDate=true&context=klasseId";
|
||||
var uri = $"https://{GetConfiguration().Host}/WebUntis/reports.do?{query}";
|
||||
using var request = ReportRequest(uri, sessionId, acceptJson: true);
|
||||
using var response = await SendAsync(request, TimeSpan.FromSeconds(20), cancellationToken);
|
||||
var payload = await ReadJsonAsync(response, cancellationToken);
|
||||
|
||||
Reference in New Issue
Block a user