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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

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

#[derive(Serialize, Deserialize, Debug)]
pub struct ParamsDataItem {
    /// data name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// data value
    #[serde(rename = "value")]
    pub r#value: Option<String>,
}

/// the data to be saved
pub type r#ParamsData = Vec<ParamsDataItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// lesson instance id
    #[serde(rename = "lessonid")]
    pub r#lessonid: Option<i64>,
    /// the page id
    #[serde(rename = "pageid")]
    pub r#pageid: Option<i64>,
    /// the data to be saved
    #[serde(rename = "data")]
    pub r#data: Option<r#ParamsData>,
    /// optional password (the lesson may be protected)
    #[serde(rename = "password")]
    pub r#password: Option<String>,
    /// if we want to review just after finishing (1 hour margin)
    #[serde(rename = "review")]
    pub r#review: Option<bool>,
}

/// The lesson generated messages
#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsMessagesItem {
    /// Message.
    #[serde(rename = "message")]
    pub r#message: Option<String>,
    /// Message type: usually a CSS identifier like: success, info, warning, error, notifyproblem, notifyerror, notifytiny, notifysuccess
    #[serde(rename = "type")]
    pub r#type: Option<String>,
}

pub type r#ReturnsMessages = Vec<ReturnsMessagesItem>;

/// 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 {
    /// New page id (if a jump was made).
    #[serde(rename = "newpageid")]
    pub r#newpageid: Option<i64>,
    /// Whether the page processing redirect directly to anoter page.
    #[serde(rename = "inmediatejump")]
    pub r#inmediatejump: Option<bool>,
    /// Whether there is not a default response.
    #[serde(rename = "nodefaultresponse")]
    pub r#nodefaultresponse: Option<bool>,
    /// The response feedback.
    #[serde(rename = "feedback")]
    pub r#feedback: Option<String>,
    /// Number of attempts remaining.
    #[serde(rename = "attemptsremaining")]
    pub r#attemptsremaining: Option<i64>,
    /// Whether the answer is correct.
    #[serde(rename = "correctanswer")]
    pub r#correctanswer: Option<bool>,
    /// Whether there aren't answers.
    #[serde(rename = "noanswer")]
    pub r#noanswer: Option<bool>,
    /// Whether is a essay question.
    #[serde(rename = "isessayquestion")]
    pub r#isessayquestion: Option<bool>,
    /// Whether we reachered the max number of attempts.
    #[serde(rename = "maxattemptsreached")]
    pub r#maxattemptsreached: Option<bool>,
    /// The response.
    #[serde(rename = "response")]
    pub r#response: Option<String>,
    /// The student answer.
    #[serde(rename = "studentanswer")]
    pub r#studentanswer: Option<String>,
    /// The user response.
    #[serde(rename = "userresponse")]
    pub r#userresponse: Option<String>,
    /// Whether the user is reviewing.
    #[serde(rename = "reviewmode")]
    pub r#reviewmode: Option<bool>,
    /// The ongoing message.
    #[serde(rename = "ongoingscore")]
    pub r#ongoingscore: Option<String>,
    /// Progress percentage in the lesson.
    #[serde(rename = "progress")]
    pub r#progress: Option<i64>,
    /// Whether we should display the menu or not in this page.
    #[serde(rename = "displaymenu")]
    pub r#displaymenu: Option<bool>,
    #[serde(rename = "messages")]
    pub r#messages: Option<r#ReturnsMessages>,
    /// 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_process_page", 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_process_page", params).await
}