Add GetAllStudents method

Author: Suiram1701

API.Test/AuthentificationTests.cs

@@ -11,14 +11,7 @@ namespace API.Test;
 [TestFixture]
 internal class AuthentificationTests
 {
-    // Login data to test
-    public static string s_Server;
-    public static string s_LoginName;
-    public static string s_UserName;
-    public static string s_Password;
-
-    [SetUp]
-    public void Setup()
+    static AuthentificationTests()
     {
         // Load a file where i saved login data
         using StreamReader str = new("LoginData.txt");
@@ -28,6 +21,12 @@ public void Setup()
         s_Password = str.ReadLine();
     }
 
+    // Login data to test
+    public static string s_Server;
+    public static string s_LoginName;
+    public static string s_UserName;
+    public static string s_Password;
+
     [Test]
     public void Authentification()
     {

API.Test/UserTest.cs

@@ -0,0 +1,46 @@
+using NUnit.Framework.Constraints;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using WebUntisAPI.Client;
+using WebUntisAPI.Client.Models;
+using static API.Test.AuthentificationTests;
+
+namespace API.Test;
+
+[Order(4)]
+[TestFixture]
+internal class UserTest
+{
+    private static WebUntisClient Client { get; set; }
+
+    [Order(0)]
+    [SetUp]
+    public void Setup()
+    {
+        Client = new("WebUntisAPI_TEST");
+    }
+
+    [Test]
+    [Order(1)]
+    public void GetStudents()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password, CancellationToken.None).Wait();
+
+        Task<Student[]> students = Client.GetAllStudentsAsync(CancellationToken.None);
+        students.Wait();
+        if (students.Result.Length > 0)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
+
+    [Order(3)]
+    [Test]
+    public void TearUp()
+    {
+        Client.LogoutAsync(CancellationToken.None).Wait();
+    }
+}

WebUntisAPI.Client/Enums.cs

@@ -21,4 +21,20 @@ public enum PersonType
         /// </summary>
         Student = 5
     }
+
+    /// <summary>
+    /// The gender of a student
+    /// </summary>
+    public enum Gender
+    {
+        /// <summary>
+        /// Male
+        /// </summary>
+        Male = 0,
+
+        /// <summary>
+        /// Female
+        /// </summary>
+        Female = 1,
+    }
 }

WebUntisAPI.Client/Models/IUser.cs

@@ -1,13 +1,39 @@
-using System;
+using Newtonsoft.Json;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 
 namespace WebUntisAPI.Client.Models
 {
+    /// <summary>
+    /// Student or teacher
+    /// </summary>
     public interface IUser
     {
-        int id { get; set; }
+        /// <summary>
+        /// Id of the user
+        /// </summary>
+        [JsonProperty("id")]
+        int Id { get; set; }
+
+        /// <summary>
+        /// WebUntis internal name of the user
+        /// </summary>
+        [JsonProperty("name")]
+        string Name { get; set; }
+
+        /// <summary>
+        /// Fore name of the user
+        /// </summary>
+        [JsonProperty("foreName")]
+        string ForeName { get; set; }
+
+        /// <summary>
+        /// Last name of the user
+        /// </summary>
+        [JsonProperty("longName")]
+        string LongName { get; set; }
     }
 }

WebUntisAPI.Client/Models/Student.cs

@@ -0,0 +1,39 @@
+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 student
+    /// </summary>
+    public sealed class Student : IUser
+    {
+        /// <inheritdoc/>
+        public int Id { get; set; }
+
+        /// <inheritdoc/>
+        public string Name { get; set; }
+
+        /// <inheritdoc/>
+        public string ForeName { get; set; }
+
+        /// <inheritdoc/>
+        public string LongName { get; set; }
+
+        /// <summary>
+        /// Idk
+        /// </summary>
+        [JsonProperty("key")]
+        public string Key { get; set; }
+
+        /// <summary>
+        /// The gender of the student
+        /// </summary>
+        [JsonProperty("gender")]
+        public Gender? Gender { get; set; }
+    }
+}

WebUntisAPI.Client/WebUntisClient.User.cs

@@ -0,0 +1,61 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Net.Http;
+using System.Net;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using WebUntisAPI.Client.Models;
+using WebUntisAPI.Client.Exceptions;
+
+namespace WebUntisAPI.Client
+{
+    public partial class WebUntisClient
+    {
+        /// <summary>
+        /// Get all students on the school
+        /// </summary>
+        /// <param name="ct">Cancellation token</param>
+        /// <param name="id">Identifier of the request</param>
+        /// <returns>An array of all students on the school</returns>
+        /// <exception cref="WebUntisException">Thrown when the WebUntis API returned an error</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when you don't logged in</exception>
+        /// <exception cref="HttpRequestException">Thrown when there was an error while the http request</exception>
+        public async Task<Student[]> GetAllStudentsAsync(CancellationToken ct, string id = "getStudents")
+        {
+            if (!LoggedIn)
+                throw new UnauthorizedAccessException("You're not logged in");
+
+            // Make request
+            JSONRPCRequestModel<object> requestModel = new JSONRPCRequestModel<object>()
+            {
+                Id = id,
+                Method = "getStudents",
+                Params = new object()
+            };
+            StringContent requestContent = new StringContent(JsonConvert.SerializeObject(requestModel), Encoding.UTF8, "application/json");
+
+            // Send request
+            HttpResponseMessage response = await _client.PostAsync(ServerUrl + "/WebUntis/jsonrpc.do", requestContent, ct);
+
+            // Check cancellation token
+            if (ct.IsCancellationRequested)
+                return null;
+
+            // Verify response
+            if (response.StatusCode != HttpStatusCode.OK)
+                throw new HttpRequestException($"There was an error while the http request (Code: {response.StatusCode}).");
+ 
+            JSONRPCResponeModel<List<Student>> responseModel = JsonConvert.DeserializeObject<JSONRPCResponeModel<List<Student>>>(await response.Content.ReadAsStringAsync());
+
+            // Check for WebUntis error
+            if (responseModel.Error != null)
+                throw responseModel.Error;
+
+            return responseModel.Result.ToArray();
+        }
+    }
+
+}

WebUntisAPI.Client/WebUntisClient.cs

@@ -12,6 +12,7 @@
 using Newtonsoft.Json;
 using WebUntisAPI.Client.Exceptions;
 using System.Threading;
+using System.ComponentModel;
 
 namespace WebUntisAPI.Client
 {
@@ -26,7 +27,7 @@ namespace WebUntisAPI.Client
     ///     Under no circumstances should 10 req. per sec., more than 1800req. per hr (but in no case more than 3600 req. per hr). If the specifications are exceeded, access to WebUntis is permanently blocked by the WebUntis API.
     ///     </para>
     /// </remarks>
-    public class WebUntisClient : IDisposable
+    public partial class WebUntisClient : IDisposable
     {
         /// <summary>
         /// Unique identifier for the client app