moodle_api 0.1.0

Moodle Webservice Client in Rust.
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
79
80
81
82
83
84
85
86
87
88
89
90

use serde::{self, Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// lesson instance id
    #[serde(rename = "lessonid")]
    pub r#lessonid: Option<i64>,
    /// lesson attempt number
    #[serde(rename = "lessonattempt")]
    pub r#lessonattempt: Option<i64>,
    /// the user id (empty for current user)
    #[serde(rename = "userid")]
    pub r#userid: Option<i64>,
}

/// Attempt grade
#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsGrade {
    /// Number of questions answered
    #[serde(rename = "nquestions")]
    pub r#nquestions: Option<i64>,
    /// Number of question attempts
    #[serde(rename = "attempts")]
    pub r#attempts: Option<i64>,
    /// Max points possible
    #[serde(rename = "total")]
    pub r#total: Option<f64>,
    /// Points earned by student
    #[serde(rename = "earned")]
    pub r#earned: Option<f64>,
    /// Calculated percentage grade
    #[serde(rename = "grade")]
    pub r#grade: Option<f64>,
    /// Number of manually graded questions
    #[serde(rename = "nmanual")]
    pub r#nmanual: Option<i64>,
    /// Point value for manually graded questions
    #[serde(rename = "manualpoints")]
    pub r#manualpoints: Option<f64>,
}

/// warning
#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsWarningsItem {
    /// item
    #[serde(rename = "item")]
    pub r#item: Option<String>,
    /// item id
    #[serde(rename = "itemid")]
    pub r#itemid: Option<i64>,
    /// the warning code can be used by the client app to implement specific behaviour
    #[serde(rename = "warningcode")]
    pub r#warningcode: Option<String>,
    /// untranslated english message to explain the warning
    #[serde(rename = "message")]
    pub r#message: Option<String>,
}

/// list of warnings
pub type r#ReturnsWarnings = Vec<ReturnsWarningsItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Returns {
    /// Attempt grade
    #[serde(rename = "grade")]
    pub r#grade: Option<ReturnsGrade>,
    /// list of warnings
    #[serde(rename = "warnings")]
    pub r#warnings: Option<r#ReturnsWarnings>,
}

pub async fn call<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<Returns> {
    let json = client
        .post("mod_lesson_get_user_attempt_grade", params)
        .await?;

    serde_json::from_value(json).map_err(|e| e.into())
}

pub async fn call_raw<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<serde_json::Value> {
    client
        .post("mod_lesson_get_user_attempt_grade", params)
        .await
}