septa-api 0.2.0

SEPTA Async Rust API Client
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

# Project Title

SEPTA API Async Rust Client.

## Project Description

This project provides developers with a standard and ergonomic Rust API for calling the various endpoints in
SEPTA API. It handles the serialization and deserialization of the requests and responses and allows the
developer to use the provided structures.

## API Status

### Real Time Data API

| Endpoint                     | Implemented | Tested |
| ---------------------------- | ----------- | ------ |
| `/Arrivals/index.php`        | ✅          | ✅     |
| `/TrainView/index.php`       | ✅          | ✅     |
| `/NextToArrive/index.php`    | ✅          | ✅     |
| `/TransitView/index.php`     | ❌          | ❌     |
| `/TransitViewAll/index.php`  | ❌          | ❌     |
| `/BusDetours/index.php`      | ❌          | ❌     |
| `/Alerts/index.php`          | ❌          | ❌     |
| `/Alerts/get_alert_data.php` | ❌          | ❌     |
| `/elevator/index.php`        | ❌          | ❌     |

### Static Data API

| Endpoint                       | Implemented | Tested |
| ------------------------------ | ----------- | ------ |
| `/RRSchedules/index.php`       | ❌          | ❌     |
| `/BusSchedules/index.php`      | ❌          | ❌     |
| `/Stops/index.php`             | ❌          | ❌     |
| `/locations/get_locations.php` | ❌          | ❌     |

## Authors

Stefan Bossbaly

## License

This project is licensed under the MIT License - see the LICENSE file for details

## Acknowledgments

- [SEPTA](https://www5.septa.org/)
- [SEPTA API](https://www3.septa.org/#/)