Add school search methods for login name and id

Author: Suiram1701

WebUntisAPI.Client/Models/School.cs

@@ -19,7 +19,7 @@ public class School
         /// Id of the school
         /// </summary>
         [JsonProperty("schoolId")]
-        public long SchoolId { get; set; }
+        public int SchoolId { get; set; }
 
         /// <summary>
         /// Login name of the school

WebUntisAPI.Client/SchoolSearch.cs

@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Runtime.CompilerServices;
@@ -28,12 +29,12 @@ public static class SchoolSearch
         /// Search for schools by the given name
         /// </summary>
         /// <param name="name">Name to search</param>
-        /// <param name="ct">Token to cancel the search request</param>
+        /// <param name="ct">Cancellation token</param>
         /// <param name="id">Identifier for the request</param>
         /// <returns>All schools found, an empty array when no school found or <see langword="null"/> when too many schools found</returns>
         /// <exception cref="WebUntisException">Throws when the WebUntis API returned an error</exception>
         /// <exception cref="HttpRequestException">Throws when an error happend while request</exception>
-        public static async Task<School[]> SearchAsync(string name, string id = "getStudents", CancellationToken ct = default)
+        public static async Task<School[]> SearchAsync(string name, string id = "searchForSchool", CancellationToken ct = default)
         {
             StringWriter sw = new StringWriter();
             using (JsonWriter writer = new JsonTextWriter(sw))
@@ -87,5 +88,99 @@ public static async Task<School[]> SearchAsync(string name, string id = "getStud
 
             return responseObject["result"]["schools"].ToObject<School[]>();
         }
+
+        /// <summary>
+        /// Get a school by the <see cref="School.LoginName"/>
+        /// </summary>
+        /// <param name="schoolName">The <see cref="School.LoginName"/> (also lower-upper case is important)</param>
+        /// <param name="id">Identifier for the request</param>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The school that was found (<see langword="null"/> when no school was found)</returns>
+        /// <exception cref="WebUntisException">Throws when the WebUntis API returned an error</exception>
+        /// <exception cref="HttpRequestException">Throws when an error happend while request</exception>
+        public static async Task<School> GetSchoolByNameAsync(string schoolName, string id = "getSchoolByName", CancellationToken ct = default)
+        {
+            Action<JsonWriter> paramAction = new Action<JsonWriter>(writer =>
+            {
+                writer.WritePropertyName("schoolname");
+                writer.WriteValue(schoolName);
+            });
+            return (await SearchForSchoolAsync(paramAction, id, ct)).FirstOrDefault();
+        }
+
+        /// <summary>
+        /// Get a school by the <see cref="School.SchoolId"/>
+        /// </summary>
+        /// <param name="schoolId">The <see cref="School.SchoolId"/></param>
+        /// <param name="id">Identifier for the request</param>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The school that was found (<see langword="null"/> when no school was found)</returns>
+        /// <exception cref="WebUntisException">Throws when the WebUntis API returned an error</exception>
+        /// <exception cref="HttpRequestException">Throws when an error happend while request</exception>
+        public static async Task<School> GetSchoolByIdAsync(int schoolId, string id = "getSchoolById", CancellationToken ct = default)
+        {
+            Action<JsonWriter> paramAction = new Action<JsonWriter>(writer =>
+            {
+                writer.WritePropertyName("schoolid");
+                writer.WriteValue(schoolId);
+            });
+            return (await SearchForSchoolAsync(paramAction, id, ct)).FirstOrDefault();
+        }
+
+        private static async Task<School[]> SearchForSchoolAsync(Action<JsonWriter> paramWriter, string id, CancellationToken ct)
+        {
+            StringWriter sw = new StringWriter();
+            using (JsonWriter writer = new JsonTextWriter(sw))
+            {
+                writer.WriteStartObject();
+
+                writer.WritePropertyName("id");
+                writer.WriteValue(id);
+
+                writer.WritePropertyName("method");
+                writer.WriteValue("searchSchool");
+
+                writer.WritePropertyName("params");
+                writer.WriteStartArray();
+                writer.WriteStartObject();
+
+                paramWriter(writer);
+
+                writer.WriteEndObject();
+                writer.WriteEndArray();
+
+                writer.WritePropertyName("jsonrpc");
+                writer.WriteValue("2.0");
+
+                writer.WriteEndObject();
+            }
+
+            StringContent requestContent = new StringContent(sw.ToString(), Encoding.UTF8, "application/json");
+
+            // Send request
+            HttpResponseMessage response;
+            using (HttpClient client = new HttpClient())
+                response = await client.PostAsync(s_API_Url, requestContent, ct);
+
+            if (ct.IsCancellationRequested)
+                return Array.Empty<School>();
+
+            // Verify response
+            if (response.StatusCode != HttpStatusCode.OK)
+                throw new HttpRequestException($"The request had an error (Code: {response.StatusCode}).");
+
+            JObject responseObject = JObject.Parse(await response.Content.ReadAsStringAsync());
+
+            // Check for WebUntis error
+            if (responseObject["error"]?.ToObject<WebUntisException>() is WebUntisException error)
+            {
+                if (error.Code == (int)WebUntisException.Codes.TooManyResults)
+                    return null;
+
+                throw error;
+            }
+
+            return responseObject["result"]["schools"].ToObject<School[]>();
+        }
     }
 }