librus-rs 2.0.1

Rust client for Librus Synergia - the Polish school diary system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! User data types.

use serde::Deserialize;

/// A user in the Librus system (student, teacher, or parent).
#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct User {
    /// Unique user identifier.
    pub id: i64,
    /// Account ID as a string.
    pub account_id: String,
    /// First name.
    pub first_name: String,
    /// Last name.
    pub last_name: String,
    /// Class the user belongs to (for students).
    pub class: Option<UserClass>,
    /// School unit the user belongs to.
    pub unit: Option<UserUnit>,
    /// Class register number (for students).
    pub class_register_number: Option<i64>,
    /// Whether this user is a school employee.
    pub is_employee: bool,
    /// User group ID.
    pub group_id: i64,
}

/// Reference to a user's class.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct UserClass {
    /// Class ID.
    pub id: i64,
    /// API URL for the class.
    pub url: String,
    /// Class UUID.
    #[serde(rename = "UUID")]
    pub uuid: String,
}

/// Reference to a school unit.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct UserUnit {
    /// Unit ID.
    pub id: i64,
    /// API URL for the unit.
    pub url: String,
}

#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct UserUrl {
    pub url: String,
}

#[derive(Debug, Deserialize)]
pub struct UserResources {
    #[serde(rename = "Users\\IndividualEducationPeriods")]
    pub users_individual_education_periods: UserUrl,
    #[serde(rename = "Users\\CrossedOutStudents")]
    pub users_crossed_out_students: UserUrl,
    #[serde(rename = "..")]
    pub root: UserUrl,
}

/// Response containing a single user.
#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct ResponseUser {
    /// The user data, if found.
    pub user: Option<User>,
    /// Related API resources.
    pub resources: UserResources,
    /// API URL for this response.
    pub url: String,
}