Add the school news feed and Move ClassregEvent get method to teaching file

Author: Suiram1701

API.Test/TeachingTests.cs

@@ -76,4 +76,17 @@ public void GetLatestImportTime()
         else
             Assert.Fail();
     }
+
+    [Test]
+    public void GetNewsFeed()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<News> news = Client.GetNewsFeedAsync(new DateTime(2023, 06, 23));
+        news.Wait();
+        if (news.Result != null)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
 }

WebUntisAPI.Client/Models/News.cs

@@ -0,0 +1,27 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace WebUntisAPI.Client.Models
+{
+    /// <summary>
+    /// All news for a day
+    /// </summary>
+    public class News
+    {
+        /// <summary>
+        /// A system message
+        /// </summary>
+        [JsonProperty("systemMessage")]
+        public NewsMessage SystemMessage { get; set; }
+
+        /// <summary>
+        /// All messages for the day
+        /// </summary>
+        [JsonProperty("messagesOfDay")]
+        public List<NewsMessage> Messages { get; set; }
+    }
+}

WebUntisAPI.Client/Models/NewsMessage.cs

@@ -0,0 +1,33 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace WebUntisAPI.Client.Models
+{
+    /// <summary>
+    /// A news message
+    /// </summary>
+    public class NewsMessage
+    {
+        /// <summary>
+        /// The id of the message
+        /// </summary>
+        [JsonProperty("id")]
+        public int Id { get; set; }
+
+        /// <summary>
+        /// The involved subject
+        /// </summary>
+        [JsonProperty("subject")]
+        public string Subject { get; set; }
+
+        /// <summary>
+        /// The normal text of the news in HTML
+        /// </summary>
+        [JsonProperty("text")]
+        public string Text { get; set; }
+    }
+}

WebUntisAPI.Client/WebUntisClient.Teaching.cs

@@ -1,9 +1,12 @@
-using System;
+using Newtonsoft.Json.Linq;
+using System;
 using System.Collections.Generic;
+using System.Net;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
 using WebUntisAPI.Client.Exceptions;
+using WebUntisAPI.Client.Extensions;
 using WebUntisAPI.Client.Models;
 
 namespace WebUntisAPI.Client
@@ -22,7 +25,7 @@ public partial class WebUntisClient
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Subject[]> GetSubjectsAsync(string id = "getSubjects", CancellationToken ct = default)
         {
-            List<Subject> subjects = await MakeRequestAsync<object, List<Subject>>(id, "getSubjects", new object(), ct);
+            List<Subject> subjects = await MakeJSONRPCRequestAsync<object, List<Subject>>(id, "getSubjects", new object(), ct);
             return subjects.ToArray();
         }
 
@@ -38,7 +41,7 @@ public async Task<Subject[]> GetSubjectsAsync(string id = "getSubjects", Cancell
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Class[]> GetClassesAsync(string id = "getClasses", CancellationToken ct = default)
         {
-            List<Class> classes = await MakeRequestAsync<object, List<Class>>(id, "getKlassen", new object(), ct);
+            List<Class> classes = await MakeJSONRPCRequestAsync<object, List<Class>>(id, "getKlassen", new object(), ct);
             return classes.ToArray();
         }
 
@@ -55,7 +58,7 @@ public async Task<Class[]> GetClassesAsync(string id = "getClasses", Cancellatio
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Class[]> GetClassesAsync(SchoolYear schoolYear, string id = "getClassesBySchoolYear", CancellationToken ct = default)
         {
-            List<Class> classes = await MakeRequestAsync<SchoolYearModel, List<Class>>(id, "getKlassen", new SchoolYearModel() { Id = schoolYear.Id }, ct);
+            List<Class> classes = await MakeJSONRPCRequestAsync<SchoolYearModel, List<Class>>(id, "getKlassen", new SchoolYearModel() { Id = schoolYear.Id }, ct);
             return classes.ToArray();
         }
 
@@ -71,7 +74,7 @@ public async Task<Class[]> GetClassesAsync(SchoolYear schoolYear, string id = "g
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Room[]> GetRoomsAsync(string id = "getRooms", CancellationToken ct = default)
         {
-            List<Room> rooms = await MakeRequestAsync<object, List<Room>>(id, "getRooms", new object(), ct);
+            List<Room> rooms = await MakeJSONRPCRequestAsync<object, List<Room>>(id, "getRooms", new object(), ct);
             return rooms.ToArray();
         }
 
@@ -87,31 +90,42 @@ public async Task<Room[]> GetRoomsAsync(string id = "getRooms", CancellationToke
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Department[]> GetDepartmentsAsync(string id = "getDepartments", CancellationToken ct = default)
         {
-            List<Department> departments = await MakeRequestAsync<object, List<Department>>(id, "getDepartments", new object(), ct);
+            List<Department> departments = await MakeJSONRPCRequestAsync<object, List<Department>>(id, "getDepartments", new object(), ct);
             return departments.ToArray();
         }
 
         /// <summary>
-        /// Get all classreg events
+        /// Get all the news for the school as string
         /// </summary>
-        /// <param name="startDate">Start date for the requested events</param>
-        /// <param name="endDate">End date for the requested events</param>
-        /// <param name="id">Identifier for the request</param>
-        /// <param name="ct">Cancellatio token</param>
-        /// <returns>All classreg events in the given date range</returns>
+        /// <param name="date">Date to get the news</param>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The new at the school for the requested day</returns>
         /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
         /// <exception cref="UnauthorizedAccessException">Thrown when you're not logged in</exception>
         /// <exception cref="HttpRequestException">Thrown when an error happend while the http request</exception>
-        /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
-        public async Task<ClassregEvent[]> GetClassregEventsAsync(DateTime startDate, DateTime endDate, string id = "getCLassregEvents", CancellationToken ct = default)
+        public async Task<News> GetNewsFeedAsync(DateTime date, CancellationToken ct = default)
         {
-            GetClassregEventsRequestModel model = new GetClassregEventsRequestModel()
-            {
-                StartDate = startDate,
-                EndDate = endDate
-            };
-            List<ClassregEvent> classregEvents = await MakeRequestAsync<GetClassregEventsRequestModel, List<ClassregEvent>>(id, "getClassregEvents", model, ct);
-            return classregEvents.ToArray();
+            // Check for disposing
+            if (_disposedValue)
+                throw new ObjectDisposedException(GetType().FullName);
+
+            // Check if you logged in
+            if (!LoggedIn)
+                throw new UnauthorizedAccessException("You're not logged in");
+
+            date.ToWebUntisTimeFormat(out string dateString, out _);
+            HttpResponseMessage response = await _client.GetAsync(ServerUrl + "/WebUntis/api/public/news/newsWidgetData?date=" + dateString, ct);
+
+            // Check cancellation token
+            if (ct.IsCancellationRequested)
+                return default;
+
+            // Verify response
+            if (response.StatusCode != HttpStatusCode.OK)
+                throw new HttpRequestException($"There was an error while the http request (Code: {response.StatusCode}).");
+
+            JToken data = JObject.Parse(await response.Content.ReadAsStringAsync()).GetValue("data");
+            return data.ToObject<News>();
         }
     }
 }

WebUntisAPI.Client/WebUntisClient.TimeTable.cs

@@ -22,7 +22,7 @@ public partial class WebUntisClient
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<StatusData> GetStatusDataAsync(string id = "getStatusData", CancellationToken ct = default)
         {
-            StatusData statusData = await MakeRequestAsync<object, StatusData>(id, "getStatusData", new object(), ct);
+            StatusData statusData = await MakeJSONRPCRequestAsync<object, StatusData>(id, "getStatusData", new object(), ct);
             return statusData;
         }
 
@@ -38,7 +38,7 @@ public async Task<StatusData> GetStatusDataAsync(string id = "getStatusData", Ca
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Timegrid> GetTimegridAsync(string id = "getTimegrid", CancellationToken ct = default)
         {
-            Timegrid timeGrid = await MakeRequestAsync<object, Timegrid>(id, "getTimegridUnits", new object(), ct);
+            Timegrid timeGrid = await MakeJSONRPCRequestAsync<object, Timegrid>(id, "getTimegridUnits", new object(), ct);
             return timeGrid;
         }
 
@@ -54,7 +54,7 @@ public async Task<Timegrid> GetTimegridAsync(string id = "getTimegrid", Cancella
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<SchoolYear[]> GetSchoolYearsAsync(string id = "getSchoolyears", CancellationToken ct = default)
         {
-            List<SchoolYear> schoolYears = await MakeRequestAsync<object, List<SchoolYear>>(id, "getSchoolyears", new object(), ct);
+            List<SchoolYear> schoolYears = await MakeJSONRPCRequestAsync<object, List<SchoolYear>>(id, "getSchoolyears", new object(), ct);
             return schoolYears.ToArray();
         }
 
@@ -70,7 +70,7 @@ public async Task<SchoolYear[]> GetSchoolYearsAsync(string id = "getSchoolyears"
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<SchoolYear> GetCurrentSchoolYearAsync(string id = "getCurrentSchoolyear", CancellationToken ct = default)
         {
-            SchoolYear schoolYear = await MakeRequestAsync<object, SchoolYear>(id, "getCurrentSchoolyear", new object(), ct);
+            SchoolYear schoolYear = await MakeJSONRPCRequestAsync<object, SchoolYear>(id, "getCurrentSchoolyear", new object(), ct);
             return schoolYear;
         }
 
@@ -86,10 +86,33 @@ public async Task<SchoolYear> GetCurrentSchoolYearAsync(string id = "getCurrentS
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<Holidays[]> GetHolidaysAsync(string id = "getHolidays", CancellationToken ct = default)
         {
-            List<Holidays> holidays = await MakeRequestAsync<object, List<Holidays>>(id, "getHolidays", new object(), ct);
+            List<Holidays> holidays = await MakeJSONRPCRequestAsync<object, List<Holidays>>(id, "getHolidays", new object(), ct);
             return holidays.ToArray();
         }
 
+        /// <summary>
+        /// Get all classreg events
+        /// </summary>
+        /// <param name="startDate">Start date for the requested events</param>
+        /// <param name="endDate">End date for the requested events</param>
+        /// <param name="id">Identifier for the request</param>
+        /// <param name="ct">Cancellatio token</param>
+        /// <returns>All classreg events in the given date range</returns>
+        /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when you're not logged in</exception>
+        /// <exception cref="HttpRequestException">Thrown when an error happend while the http request</exception>
+        /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
+        public async Task<ClassregEvent[]> GetClassregEventsAsync(DateTime startDate, DateTime endDate, string id = "getCLassregEvents", CancellationToken ct = default)
+        {
+            GetClassregEventsRequestModel model = new GetClassregEventsRequestModel()
+            {
+                StartDate = startDate,
+                EndDate = endDate
+            };
+            List<ClassregEvent> classregEvents = await MakeJSONRPCRequestAsync<GetClassregEventsRequestModel, List<ClassregEvent>>(id, "getClassregEvents", model, ct);
+            return classregEvents.ToArray();
+        }
+
         #region Timetable
         /// <summary>
         /// Get the timetable the user as their you logged in
@@ -140,7 +163,7 @@ public async Task<Period[]> GetTimetableForClassAsync(Class @class, DateTime sta
                 StartDate = startDate,
                 EndDate = endDate
             };
-            List<Period> timetable = await MakeRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
+            List<Period> timetable = await MakeJSONRPCRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
             return timetable.ToArray();
         }
 
@@ -173,7 +196,7 @@ public async Task<Period[]> GetTimetableForTeacherAsync(Teacher teacher, DateTim
                 StartDate = startDate,
                 EndDate = endDate
             };
-            List<Period> timetable = await MakeRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
+            List<Period> timetable = await MakeJSONRPCRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
             return timetable.ToArray();
         }
 
@@ -206,7 +229,7 @@ public async Task<Period[]> GetTimetableForSubjectAsync(Subject subject, DateTim
                 StartDate = startDate,
                 EndDate = endDate
             };
-            List<Period> timetable = await MakeRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
+            List<Period> timetable = await MakeJSONRPCRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
             return timetable.ToArray();
         }
 
@@ -239,7 +262,7 @@ public async Task<Period[]> GetTimetableForRoomAsync(Room room, DateTime startDa
                 StartDate = startDate,
                 EndDate = endDate
             };
-            List<Period> timetable = await MakeRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
+            List<Period> timetable = await MakeJSONRPCRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
             return timetable.ToArray();
         }
 
@@ -272,7 +295,7 @@ public async Task<Period[]> GetTimetableForStudentAsync(Student student, DateTim
                 StartDate = startDate,
                 EndDate = endDate
             };
-            List<Period> timetable = await MakeRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
+            List<Period> timetable = await MakeJSONRPCRequestAsync<TimetableRequestModel, List<Period>>(id, "getTimetable", requestModel, ct);
             return timetable.ToArray();
         }
         #endregion

WebUntisAPI.Client/WebUntisClient.User.cs

@@ -40,7 +40,7 @@ public partial class WebUntisClient
         /// <exception cref="ObjectDisposedException">Thrown when the object is disposed</exception>
         public async Task<Student[]> GetStudentsAsync(string id = "getStudents", CancellationToken ct = default)
         {
-            List<Student> students = await MakeRequestAsync<object, List<Student>>(id, "getStudents", new object(), ct);
+            List<Student> students = await MakeJSONRPCRequestAsync<object, List<Student>>(id, "getStudents", new object(), ct);
             return students.ToArray();
         }
 
@@ -56,7 +56,7 @@ public async Task<Student[]> GetStudentsAsync(string id = "getStudents", Cancell
         /// <exception cref="ObjectDisposedException">Thrown when the object is disposed</exception>
         public async Task<Teacher[]> GetTeachersAsync(string id = "getTeachers", CancellationToken ct = default)
         {
-            List<Teacher> teachers = await MakeRequestAsync<object, List<Teacher>>(id, "getTeachers", new object(), ct);
+            List<Teacher> teachers = await MakeJSONRPCRequestAsync<object, List<Teacher>>(id, "getTeachers", new object(), ct);
             return teachers.ToArray();
         }
 
@@ -81,7 +81,7 @@ public async Task<int> GetPersonIdAsync(string forename, string surname, UserTyp
                 Surname = surname,
                 UserType = (int)type
             };
-            return await MakeRequestAsync<GetPersonIdRequestModel, int>(id, "getPersonId", model, ct);
+            return await MakeJSONRPCRequestAsync<GetPersonIdRequestModel, int>(id, "getPersonId", model, ct);
         }
     }
 }

WebUntisAPI.Client/WebUntisClient.cs

@@ -230,7 +230,7 @@ public async Task LogoutAsync(string id = "getStudents", CancellationToken ct =
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
         public async Task<DateTime> GetLatestImportTimeAsync(string id = "getLatestImportTime", CancellationToken ct = default)
         {
-            long timestamp = await MakeRequestAsync<object, long>(id, "getLatestImportTime", new object(), ct);
+            long timestamp = await MakeJSONRPCRequestAsync<object, long>(id, "getLatestImportTime", new object(), ct);
             return new DateTime(1970, 01, 01, 0, 0, 0, DateTimeKind.Utc).AddTicks(timestamp * 10000);
         }
 
@@ -249,7 +249,7 @@ public async Task<DateTime> GetLatestImportTimeAsync(string id = "getLatestImpor
         /// <exception cref="UnauthorizedAccessException">Thrown when the client isn't logged in</exception>
         /// <exception cref="HttpRequestException">Thrown when an error happend while the http request</exception>
         /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
-        private async Task<TResult> MakeRequestAsync<TRequest, TResult>(string id, string methodName, TRequest requestParams, CancellationToken ct, string requestUrl = "/WebUntis/jsonrpc.do")
+        private async Task<TResult> MakeJSONRPCRequestAsync<TRequest, TResult>(string id, string methodName, TRequest requestParams, CancellationToken ct, string requestUrl = "/WebUntis/jsonrpc.do")
         {
             // Check for disposing
             if (_disposedValue)