dvb 0.8.0

An unofficial crate to query publicly accessible API methods for Dresden's public transport system.
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

//! Route planning and route details for Dresden public transport.

use crate::{DvbResponse, common::ArrivalState, error::Result, time::DvbTime};
use serde::{Deserialize, Serialize};
use serde_json::Value;

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Route {
    pub duration: Option<u32>,
    pub fare_zone_destination: Option<u32>,
    pub fare_zone_names: Option<String>,
    pub fare_zone_names_day_ticket: Option<String>,
    pub fare_zone_origin: Option<u32>,
    pub interchanges: Option<u32>,
    pub map_data: Option<Vec<String>>,
    pub map_pdf_id: Option<String>,
    pub mot_chain: Option<Vec<MotChain>>,
    pub net: Option<String>,
    pub number_of_fare_zones: Option<String>,
    pub number_of_fare_zones_day_ticket: Option<String>,
    pub partial_routes: Option<Vec<PartialRoute>>,
    pub price: Option<String>,
    pub price_day_ticket: Option<String>,
    pub price_level: Option<u32>,
    pub route_cancelled: Option<bool>,
    pub route_id: Option<u32>,
    pub tickets: Option<Vec<Ticket>>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Routes {
    #[serde(default)]
    pub routes: Vec<Route>,
    pub session_id: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct MotChain {
    pub changes: Option<Vec<String>>,
    pub direction: Option<String>,
    pub diva: Option<Diva>,
    pub dl_id: Option<String>,
    pub name: Option<String>,
    pub operator_code: Option<String>,
    pub product_name: Option<String>,
    pub stateless_id: Option<String>,
    pub train_number: Option<String>,
    pub transportation_company: Option<String>,
    pub r#type: Option<crate::common::Mot>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Diva {
    pub network: Option<String>,
    pub number: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct PartialRoute {
    pub duration: Option<u32>,
    pub map_data_index: Option<i32>,
    pub mot: Option<Mot>,
    pub next_departure_times: Option<Vec<DvbTime>>,
    pub partial_route_id: Option<u32>,
    pub previous_departure_times: Option<Vec<DvbTime>>,
    pub regular_stops: Option<Vec<RegularStop>>,
    pub shift: Option<String>,
    pub infos: Option<Vec<String>>,
    pub trip_cancelled: Option<bool>,
    pub changeover_endangered: Option<bool>,
    pub booking_link: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Mot {
    #[serde(default)]
    pub changes: Vec<String>,
    pub direction: Option<String>,
    pub diva: Option<Diva>,
    pub dl_id: Option<String>,
    pub name: Option<String>,
    pub operator_code: Option<String>,
    pub product_name: Option<String>,
    pub stateless_id: Option<String>,
    pub train_number: Option<String>,
    pub transportation_company: Option<String>,
    pub r#type: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct RegularStop {
    pub arrival_time: Option<DvbTime>,
    pub arrival_real_time: Option<DvbTime>,
    pub arrival_state: Option<ArrivalState>,
    pub cancel_reasons: Vec<String>,
    pub data_id: Option<String>,
    pub departure_time: Option<DvbTime>,
    pub departure_real_time: Option<DvbTime>,
    pub departure_state: Option<ArrivalState>,
    pub dh_id: Option<String>,
    pub latitude: Option<f64>,
    pub longitude: Option<f64>,
    pub map_pdf_id: Option<String>,
    pub name: Option<String>,
    pub occupancy: Option<String>,
    #[serde(default)]
    pub park_and_rail: Vec<ParkAndRail>,
    pub place: Option<String>,
    pub platform: Option<Platform>,
    pub r#type: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Platform {
    pub name: Option<String>,
    pub r#type: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Ticket {
    pub fare_zone_names: Option<String>,
    pub name: Option<String>,
    pub number_of_fare_zones: Option<String>,
    pub price: Option<String>,
    pub price_level: Option<u32>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct ParkAndRail {
    pub coordinates: Option<Coordinate>,
    pub free_spaces: Option<u32>,
    pub name: Option<String>,
    #[serde(default)]
    pub parking_lots: Vec<ParkingLot>,
    pub disabled_persons_only: Option<bool>,
    pub total_spaces: Option<u32>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct Coordinate {
    pub lat: Option<f64>,
    pub lng: Option<f64>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct ParkingLot {
    pub coordinates: Coordinate,
    #[serde(default)]
    pub occupied: bool,
    #[serde(default)]
    pub disabled_persons_only: bool,
}

const ROUTE_URL: &str = "https://webapi.vvo-online.de/tr/trips";

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct MobilitySettings {
    /// Accessibility level: `"None"`, `"Medium"`, `"High"`, or `"Individual"`.
    pub mobility_restriction: Option<String>,
    /// Allow solid stairs (only with `"Individual"` restriction).
    pub solid_stairs: Option<bool>,
    /// Allow escalators (only with `"Individual"` restriction).
    pub escalators: Option<bool>,
    /// Prefer fewest changes (only with `"Individual"` restriction).
    pub least_change: Option<bool>,
    /// Entrance requirement: `"Any"`, `"SmallStep"`, or `"NoStep"`.
    pub entrance: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct StandardSettings {
    /// Modes of transport to include.
    pub mot: Option<Vec<String>>,
    /// Maximum transfers: `"Unlimited"`, `"Two"`, `"One"`, or `"None"`.
    pub max_changes: Option<String>,
    /// Walking speed: `"VerySlow"`, `"Slow"`, `"Normal"`, `"Fast"`, or `"VeryFast"`.
    pub walking_speed: Option<String>,
    /// Maximum walking distance to a stop in minutes.
    pub footpath_to_stop: Option<u32>,
    /// Include nearby alternative stops.
    pub include_alternative_stops: Option<bool>,
    /// Extra charge filter: `""`, `"None"`, or `"LocalTraffic"`.
    pub extra_charge: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct Params<'a> {
    /// Origin stop ID.
    pub origin: &'a str,
    /// Destination stop ID.
    pub destination: &'a str,
    /// Time for the query (DvbTime).
    pub time: DvbTime,
    /// Interpret time as arrival time.
    pub isarrivaltime: bool,
    /// Include short-term changes.
    pub shorttermchanges: bool,
    /// Response format (e.g., "json").
    pub format: &'a str,
    /// Intermediate stop ID.
    pub via: Option<&'a str>,
    /// Accessibility preferences.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mobility_settings: Option<MobilitySettings>,
    /// Journey preferences (transport modes, max changes, walking speed, etc.).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub standard_settings: Option<StandardSettings>,
}

pub async fn route_details_json<'a>(params: &Params<'a>) -> Result<Value> {
    Ok(reqwest::Client::new()
        .post(ROUTE_URL)
        .json(&params)
        .send()
        .await?
        .json()
        .await?)
}

/// Queries possible routes between two stops using the VVO WebAPI.
///
/// # Arguments
/// * `params` - Parameters including origin, destination, time, and optional flags.
///
/// # Returns
/// * `Result<DvbResponse<Routes>>` - The parsed response containing possible routes.
///
/// Endpoint: `https://webapi.vvo-online.de/tr/trips`
pub async fn route_details<'a>(params: &Params<'a>) -> Result<DvbResponse<Routes>> {
    let routes = reqwest::Client::new()
        .post(ROUTE_URL)
        .json(&params)
        .send()
        .await?
        .json()
        .await?;

    Ok(routes)
}