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

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

#[derive(Serialize, Deserialize, Debug)]
pub struct ParamsDataItem {
    /// The field id.
    #[serde(rename = "fieldid")]
    pub r#fieldid: Option<i64>,
    /// The subfield name (if required).
    #[serde(rename = "subfield")]
    pub r#subfield: Option<String>,
    /// The contents for the field always JSON encoded.
    #[serde(rename = "value")]
    pub r#value: Option<String>,
}

/// The fields data to be created
pub type r#ParamsData = Vec<ParamsDataItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// data instance id
    #[serde(rename = "databaseid")]
    pub r#databaseid: Option<i64>,
    /// Group id, 0 means that the function will determine the user group
    #[serde(rename = "groupid")]
    pub r#groupid: Option<i64>,
    /// The fields data to be created
    #[serde(rename = "data")]
    pub r#data: Option<r#ParamsData>,
}

pub type r#ReturnsGeneralnotifications = Vec<String>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsFieldnotificationsItem {
    /// The field name.
    #[serde(rename = "fieldname")]
    pub r#fieldname: Option<String>,
    /// The notification for the field.
    #[serde(rename = "notification")]
    pub r#notification: Option<String>,
}

pub type r#ReturnsFieldnotifications = Vec<ReturnsFieldnotificationsItem>;

/// 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 {
    /// True new created entry id. 0 if the entry was not created.
    #[serde(rename = "newentryid")]
    pub r#newentryid: Option<i64>,
    #[serde(rename = "generalnotifications")]
    pub r#generalnotifications: Option<r#ReturnsGeneralnotifications>,
    #[serde(rename = "fieldnotifications")]
    pub r#fieldnotifications: Option<r#ReturnsFieldnotifications>,
    /// 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_data_add_entry", 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_data_add_entry", params).await
}