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

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

#[derive(Serialize, Deserialize, Debug)]
pub struct ParamsResponsesItem {
    /// The response name (usually type[index]_id).
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// The response value.
    #[serde(rename = "value")]
    pub r#value: Option<String>,
}

/// The data to be processed.
pub type r#ParamsResponses = Vec<ParamsResponsesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// Feedback instance id.
    #[serde(rename = "feedbackid")]
    pub r#feedbackid: Option<i64>,
    /// The page being processed.
    #[serde(rename = "page")]
    pub r#page: Option<i64>,
    /// The data to be processed.
    #[serde(rename = "responses")]
    pub r#responses: Option<r#ParamsResponses>,
    /// Whether we want to jump to previous page.
    #[serde(rename = "goprevious")]
    pub r#goprevious: Option<bool>,
    /// Course where user completes the feedback (for site feedbacks only).
    #[serde(rename = "courseid")]
    pub r#courseid: Option<i64>,
}

/// 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 {
    /// The page to jump to.
    #[serde(rename = "jumpto")]
    pub r#jumpto: Option<i64>,
    /// If the user completed the feedback.
    #[serde(rename = "completed")]
    pub r#completed: Option<bool>,
    /// The completion page contents.
    #[serde(rename = "completionpagecontents")]
    pub r#completionpagecontents: Option<String>,
    /// The link (could be relative) to show after submit.
    #[serde(rename = "siteaftersubmit")]
    pub r#siteaftersubmit: Option<String>,
    /// 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_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_feedback_process_page", params).await
}