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

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

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// lesson instance id
    #[serde(rename = "lessonid")]
    pub r#lessonid: Option<i64>,
}

/// The reasons why the user cannot attempt the lesson
#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsPreventaccessreasonsItem {
    /// Reason lang string code
    #[serde(rename = "reason")]
    pub r#reason: Option<String>,
    /// Additional data
    #[serde(rename = "data")]
    pub r#data: Option<String>,
    /// Complete html message
    #[serde(rename = "message")]
    pub r#message: Option<String>,
}

pub type r#ReturnsPreventaccessreasons = Vec<ReturnsPreventaccessreasonsItem>;

/// 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 {
    /// Whether the user can manage the lesson or not.
    #[serde(rename = "canmanage")]
    pub r#canmanage: Option<bool>,
    /// Whether the user can grade the lesson or not.
    #[serde(rename = "cangrade")]
    pub r#cangrade: Option<bool>,
    /// Whether the user can view the lesson reports or not.
    #[serde(rename = "canviewreports")]
    pub r#canviewreports: Option<bool>,
    /// Whether the lesson is in review mode for the current user.
    #[serde(rename = "reviewmode")]
    pub r#reviewmode: Option<bool>,
    /// The number of attempts done by the user.
    #[serde(rename = "attemptscount")]
    pub r#attemptscount: Option<i64>,
    /// The last page seen id.
    #[serde(rename = "lastpageseen")]
    pub r#lastpageseen: Option<i64>,
    /// Whether the user left during a timed session.
    #[serde(rename = "leftduringtimedsession")]
    pub r#leftduringtimedsession: Option<bool>,
    /// The lesson first page id.
    #[serde(rename = "firstpageid")]
    pub r#firstpageid: Option<i64>,
    #[serde(rename = "preventaccessreasons")]
    pub r#preventaccessreasons: Option<r#ReturnsPreventaccessreasons>,
    /// 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_lesson_access_information", 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_lesson_access_information", params)
        .await
}