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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

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

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

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAssessmentFeedbackcontentfilesItem {
    /// File name.
    #[serde(rename = "filename")]
    pub r#filename: Option<String>,
    /// File path.
    #[serde(rename = "filepath")]
    pub r#filepath: Option<String>,
    /// File size.
    #[serde(rename = "filesize")]
    pub r#filesize: Option<i64>,
    /// Downloadable file url.
    #[serde(rename = "fileurl")]
    pub r#fileurl: Option<String>,
    /// Time modified.
    #[serde(rename = "timemodified")]
    pub r#timemodified: Option<i64>,
    /// File mime type.
    #[serde(rename = "mimetype")]
    pub r#mimetype: Option<String>,
    /// Whether is an external file.
    #[serde(rename = "isexternalfile")]
    pub r#isexternalfile: Option<bool>,
    /// The repository type for the external files.
    #[serde(rename = "repositorytype")]
    pub r#repositorytype: Option<String>,
}

/// feedbackcontentfiles
pub type r#ReturnsAssessmentFeedbackcontentfiles = Vec<ReturnsAssessmentFeedbackcontentfilesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAssessmentFeedbackattachmentfilesItem {
    /// File name.
    #[serde(rename = "filename")]
    pub r#filename: Option<String>,
    /// File path.
    #[serde(rename = "filepath")]
    pub r#filepath: Option<String>,
    /// File size.
    #[serde(rename = "filesize")]
    pub r#filesize: Option<i64>,
    /// Downloadable file url.
    #[serde(rename = "fileurl")]
    pub r#fileurl: Option<String>,
    /// Time modified.
    #[serde(rename = "timemodified")]
    pub r#timemodified: Option<i64>,
    /// File mime type.
    #[serde(rename = "mimetype")]
    pub r#mimetype: Option<String>,
    /// Whether is an external file.
    #[serde(rename = "isexternalfile")]
    pub r#isexternalfile: Option<bool>,
    /// The repository type for the external files.
    #[serde(rename = "repositorytype")]
    pub r#repositorytype: Option<String>,
}

/// feedbackattachmentfiles
pub type r#ReturnsAssessmentFeedbackattachmentfiles =
    Vec<ReturnsAssessmentFeedbackattachmentfilesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsAssessment {
    /// The primary key of the record.
    #[serde(rename = "id")]
    pub r#id: Option<i64>,
    /// The id of the assessed submission
    #[serde(rename = "submissionid")]
    pub r#submissionid: Option<i64>,
    /// The id of the reviewer who makes this assessment
    #[serde(rename = "reviewerid")]
    pub r#reviewerid: Option<i64>,
    /// The weight of the assessment for the purposes of aggregation
    #[serde(rename = "weight")]
    pub r#weight: Option<i64>,
    /// If 0 then the assessment was allocated but the reviewer has not assessed yet. If greater than 0 then the timestamp of when the reviewer assessed for the first time
    #[serde(rename = "timecreated")]
    pub r#timecreated: Option<i64>,
    /// If 0 then the assessment was allocated but the reviewer has not assessed yet. If greater than 0 then the timestamp of when the reviewer assessed for the last time
    #[serde(rename = "timemodified")]
    pub r#timemodified: Option<i64>,
    /// The aggregated grade for submission suggested by the reviewer. The grade 0..100 is computed from the values assigned to the assessment dimensions fields. If NULL then it has not been aggregated yet.
    #[serde(rename = "grade")]
    pub r#grade: Option<f64>,
    /// The computed grade 0..100 for this assessment. If NULL then it has not been computed yet.
    #[serde(rename = "gradinggrade")]
    pub r#gradinggrade: Option<f64>,
    /// Grade for the assessment manually overridden by a teacher. Grade is always from interval 0..100. If NULL then the grade is not overriden.
    #[serde(rename = "gradinggradeover")]
    pub r#gradinggradeover: Option<f64>,
    /// The id of the user who has overridden the grade for submission.
    #[serde(rename = "gradinggradeoverby")]
    pub r#gradinggradeoverby: Option<i64>,
    /// The comment/feedback from the reviewer for the author.
    #[serde(rename = "feedbackauthor")]
    pub r#feedbackauthor: Option<String>,
    /// feedbackauthor format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN
    #[serde(rename = "feedbackauthorformat")]
    pub r#feedbackauthorformat: Option<i64>,
    /// Are there some files attached to the feedbackauthor field? Sets to 1 by file_postupdate_standard_filemanager().
    #[serde(rename = "feedbackauthorattachment")]
    pub r#feedbackauthorattachment: Option<i64>,
    /// The comment/feedback from the teacher for the reviewer. For example the reason why the grade for assessment was overridden
    #[serde(rename = "feedbackreviewer")]
    pub r#feedbackreviewer: Option<String>,
    /// feedbackreviewer format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN
    #[serde(rename = "feedbackreviewerformat")]
    pub r#feedbackreviewerformat: Option<i64>,
    /// feedbackcontentfiles
    #[serde(rename = "feedbackcontentfiles")]
    pub r#feedbackcontentfiles: Option<r#ReturnsAssessmentFeedbackcontentfiles>,
    /// feedbackattachmentfiles
    #[serde(rename = "feedbackattachmentfiles")]
    pub r#feedbackattachmentfiles: Option<r#ReturnsAssessmentFeedbackattachmentfiles>,
}

/// 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 = "assessment")]
    pub r#assessment: Option<ReturnsAssessment>,
    /// 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_workshop_get_assessment", 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_workshop_get_assessment", params).await
}