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
140
141
142
143
144
145
146
147
148
149
150
151
152
153

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

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// Feedback instance id
    #[serde(rename = "feedbackid")]
    pub r#feedbackid: Option<i64>,
    /// Group id, 0 means that the function will determine the user group
    #[serde(rename = "groupid")]
    pub r#groupid: Option<i64>,
    /// The page of records to return.
    #[serde(rename = "page")]
    pub r#page: Option<i64>,
    /// The number of records to return per page
    #[serde(rename = "perpage")]
    pub r#perpage: Option<i64>,
    /// Course where user completes the feedback (for site feedbacks only).
    #[serde(rename = "courseid")]
    pub r#courseid: Option<i64>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAttemptsItemResponsesItem {
    /// Response id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// Response name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// Response ready for output
    #[serde(rename = "printval")]
    pub r#printval: Option<String>,
    /// Response raw value
    #[serde(rename = "rawval")]
    pub r#rawval: Option<String>,
}

pub type r#ReturnsAttemptsItemResponses = Vec<ReturnsAttemptsItemResponsesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAttemptsItem {
    /// Completed id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// Course id
    #[serde(rename = "courseid")]
    pub r#courseid: Option<i64>,
    /// User who responded
    #[serde(rename = "userid")]
    pub r#userid: Option<i64>,
    /// Time modified for the response
    #[serde(rename = "timemodified")]
    pub r#timemodified: Option<i64>,
    /// User full name
    #[serde(rename = "fullname")]
    pub r#fullname: Option<String>,
    #[serde(rename = "responses")]
    pub r#responses: Option<r#ReturnsAttemptsItemResponses>,
}

pub type r#ReturnsAttempts = Vec<ReturnsAttemptsItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAnonattemptsItemResponsesItem {
    /// Response id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// Response name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// Response ready for output
    #[serde(rename = "printval")]
    pub r#printval: Option<String>,
    /// Response raw value
    #[serde(rename = "rawval")]
    pub r#rawval: Option<String>,
}

pub type r#ReturnsAnonattemptsItemResponses = Vec<ReturnsAnonattemptsItemResponsesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAnonattemptsItem {
    /// Completed id
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// Course id
    #[serde(rename = "courseid")]
    pub r#courseid: Option<i64>,
    /// Response number
    #[serde(rename = "number")]
    pub r#number: Option<i64>,
    #[serde(rename = "responses")]
    pub r#responses: Option<r#ReturnsAnonattemptsItemResponses>,
}

pub type r#ReturnsAnonattempts = Vec<ReturnsAnonattemptsItem>;

/// 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 {
    #[serde(rename = "attempts")]
    pub r#attempts: Option<r#ReturnsAttempts>,
    /// Total responses count.
    #[serde(rename = "totalattempts")]
    pub r#totalattempts: Option<i64>,
    #[serde(rename = "anonattempts")]
    pub r#anonattempts: Option<r#ReturnsAnonattempts>,
    /// Total anonymous responses count.
    #[serde(rename = "totalanonattempts")]
    pub r#totalanonattempts: Option<i64>,
    /// 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_feedback_get_responses_analysis", 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_feedback_get_responses_analysis", params)
        .await
}