File: MapApi.md

package info (click to toggle)
rust-motis-openapi-sdk 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 496 kB
  • sloc: sh: 40; makefile: 4
file content (127 lines) | stat: -rw-r--r-- 4,389 bytes parent folder | download
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
# \MapApi

All URIs are relative to *https://europe.motis-project.de*

Method | HTTP request | Description
------------- | ------------- | -------------
[**initial**](MapApi.md#initial) | **GET** /api/v1/map/initial | initial location to view the map at after loading based on where public transport should be visible
[**levels**](MapApi.md#levels) | **GET** /api/v1/map/levels | Get all available levels for a map section
[**stops**](MapApi.md#stops) | **GET** /api/v1/map/stops | Get all stops for a map section
[**trips**](MapApi.md#trips) | **GET** /api/v1/map/trips | Given a area frame (box defined by top right and bottom left corner) and a time frame, it returns all trips and their respective shapes that operate in this area + time frame. Trips are filtered by zoom level. On low zoom levels, only long distance trains will be shown while on high zoom levels, also metros, buses and trams will be returned. 



## initial

> models::Initial200Response initial()
initial location to view the map at after loading based on where public transport should be visible

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::Initial200Response**](initial_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## levels

> Vec<f64> levels(min, max)
Get all available levels for a map section

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**min** | **String** | latitude,longitude pair of the lower right coordinate | [required] |
**max** | **String** | latitude,longitude pair of the upper left coordinate | [required] |

### Return type

**Vec<f64>**

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## stops

> Vec<models::Place> stops(min, max)
Get all stops for a map section

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**min** | **String** | latitude,longitude pair of the lower right coordinate | [required] |
**max** | **String** | latitude,longitude pair of the upper left coordinate | [required] |

### Return type

[**Vec<models::Place>**](Place.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## trips

> Vec<models::TripSegment> trips(zoom, min, max, start_time, end_time)
Given a area frame (box defined by top right and bottom left corner) and a time frame, it returns all trips and their respective shapes that operate in this area + time frame. Trips are filtered by zoom level. On low zoom levels, only long distance trains will be shown while on high zoom levels, also metros, buses and trams will be returned. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zoom** | **f64** | current zoom level | [required] |
**min** | **String** | latitude,longitude pair of the lower right coordinate | [required] |
**max** | **String** | latitude,longitude pair of the upper left coordinate | [required] |
**start_time** | **String** | start of the time window | [required] |
**end_time** | **String** | end if the time window | [required] |

### Return type

[**Vec<models::TripSegment>**](TripSegment.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)