Add substitution informations to the periods

Author: Suiram1701

API.Test/TimeTableTests.cs

@@ -82,7 +82,7 @@ public void GetTimetable()
     {
         Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
 
-        Task<Period[]> timetable = Client.GetTimetableForStudentAsync(Client.User as Student, new DateTime(2023, 06, 09), new DateTime(2023, 06, 16));
+        Task<Period[]> timetable = Client.GetTimetableForStudentAsync(Client.User as Student, new DateTime(2023, 05, 29), new DateTime(2023, 06, 2));
         timetable.Wait();
         if (timetable.Result.Length > 0)
             Assert.Pass();

WebUntisAPI.Client/Converter/TimetableRequestModelJsonConverter.cs

@@ -0,0 +1,75 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Extensions;
+using WebUntisAPI.Client.Models;
+
+namespace WebUntisAPI.Client.Converter
+{
+    internal class TimetableRequestModelJsonConverter : JsonConverter<TimetableRequestModel>
+    {
+        public override TimetableRequestModel ReadJson(JsonReader reader, Type objectType, TimetableRequestModel existingValue, bool hasExistingValue, JsonSerializer serializer)
+        {
+            JObject options = JObject.Load(reader).Value<JObject>("options");
+            return new TimetableRequestModel()
+            {
+                Id = options.Value<JObject>("element").Value<int>("id"),
+                Type = options.Value<JObject>("element").Value<int>("type"),
+                StartDate = new DateTime().FromWebUntisTimeFormat(options.Value<string>("startDate"), "000"),
+                EndDate = new DateTime().FromWebUntisTimeFormat(options.Value<string>("endDate"), "000")
+            };
+        }
+
+        public override void WriteJson(JsonWriter writer, TimetableRequestModel value, JsonSerializer serializer)
+        {
+            writer.WriteStartObject();
+
+            writer.WritePropertyName("options");
+            writer.WriteStartObject();
+
+            writer.WritePropertyName("element");
+            writer.WriteStartObject();
+
+            writer.WritePropertyName("id");
+            writer.WriteValue(value.Id);
+
+            writer.WritePropertyName("type");
+            writer.WriteValue(value.Type);
+
+            writer.WriteEndObject();
+
+            value.StartDate.ToWebUntisTimeFormat(out string startDateString, out _);
+            writer.WritePropertyName("startDate");
+            writer.WriteValue(startDateString);
+
+            value.EndDate.ToWebUntisTimeFormat(out string endDateString, out _);
+            writer.WritePropertyName("endDate");
+            writer.WriteValue(endDateString);
+
+            writer.WritePropertyName("showBooking");
+            writer.WriteValue(true);
+
+            writer.WritePropertyName("showInfo");
+            writer.WriteValue(true);
+
+            writer.WritePropertyName("showSubstText");
+            writer.WriteValue(true);
+
+            writer.WritePropertyName("showLsText");
+            writer.WriteValue(true);
+
+            writer.WritePropertyName("showLsNumber");
+            writer.WriteValue(true);
+
+            writer.WritePropertyName("showStudentgroup");
+            writer.WriteValue(true);
+
+            writer.WriteEndObject();
+            writer.WriteEndObject();
+        }
+    }
+}

WebUntisAPI.Client/Exceptions/WebUntisException.cs

@@ -38,7 +38,12 @@ public enum Codes
             /// <summary>
             /// The element that you requested was not found
             /// </summary>
-            NoSuchElementFound = -7002
+            NoSuchElementFound = -7002,
+
+            /// <summary>
+            /// Access dinied for substitutions
+            /// </summary>
+            NoRightForGetSubstitutions = -8509
         }
 
         /// <summary>

WebUntisAPI.Client/Models/Period.cs

@@ -84,18 +84,42 @@ public class Period
         [JsonProperty("code")]
         public Code Code { get; set; } = Code.None;
 
+        /// <summary>
+        /// Number of the lesson
+        /// </summary>
+        [JsonProperty("lsnumber")]
+        public int LessonNumber { get; set; }
+
         /// <summary>
         /// Statistical flags of the lesson
         /// </summary>
         [JsonProperty("statflags")]
         public string StatisticalFlags { get; set; } = string.Empty;
 
         /// <summary>
-        /// Text of the lesson
+        /// Informations about the lesson
         /// </summary>
         [JsonProperty("lstext")]
         public string LessonText { get; set; } = string.Empty;
 
+        /// <summary>
+        /// Additional informations about the student group
+        /// </summary>
+        [JsonProperty("sg")]
+        public string StudentGroup { get; set; } = string.Empty;
+
+        /// <summary>
+        /// Additional text when it is a substitution
+        /// </summary>
+        [JsonProperty("substText")]
+        public string SubstitutionText { get; set; } = string.Empty;
+
+        /// <summary>
+        /// Additional informations for the students
+        /// </summary>
+        [JsonProperty("info")]
+        public string Info { get; set; } = string.Empty;
+
         /// <summary>
         /// The activity type in the lesson
         /// </summary>

WebUntisAPI.Client/Models/TimetableRequestModel.cs

@@ -8,12 +8,12 @@
 
 namespace WebUntisAPI.Client.Models
 {
+    [JsonConverter(typeof(TimetableRequestModelJsonConverter))]
     internal struct TimetableRequestModel
     {
         /// <summary>
         /// Id of that what you want too request
         /// </summary>
-        [JsonProperty("id")]
         public int Id { get; set; }
 
         /// <summary>
@@ -29,21 +29,16 @@ internal struct TimetableRequestModel
         ///         <item>5 = student</item>
         ///     </list>
         /// </remarks>
-        [JsonProperty("type")]
         public int Type { get; set; }
 
         /// <summary>
         /// Start date of requested informations
         /// </summary>
-        [JsonProperty("startDate")]
-        [JsonConverter(typeof(DateJsonConverter))]
         public DateTime StartDate { get; set; }
 
         /// <summary>
         /// End date of the requested informations
         /// </summary>
-        [JsonProperty("endDate")]
-        [JsonConverter(typeof(DateJsonConverter))]
         public DateTime EndDate { get; set; }
     }
 }