mirror of
https://gitlab.com/t6353/sharee.bike.wiki.git
synced 2024-05-08 19:26:34 +02:00
Compare commits
9 commits
0c373c66ba
...
cdc5b12896
Author | SHA1 | Date | |
---|---|---|---|
cdc5b12896 | |||
cd0c412b0a | |||
989aac39d3 | |||
de04ea5ad3 | |||
7c8b8cc1b5 | |||
a125644484 | |||
bf90e41810 | |||
9b2b2814ab | |||
044cbdc6be |
|
@ -3,7 +3,7 @@
|
|||
| key | Required | Format | Comment |
|
||||
| ------------------ | -------- | -------- | ------------------------------------------------- |
|
||||
| user_id | + | text | returns user_id email-address |
|
||||
| user_group | + | array | user group describes user registered bike fleets |
|
||||
| user_group | o | array | user group describes user registered bike fleets |
|
||||
| user_tour | o | array | user tour describes registered service tour |
|
||||
| debuglevel | o | text | returns user specified debuglevel for development |
|
||||
| response | + | text | return request value |
|
||||
|
|
|
@ -15,19 +15,26 @@
|
|||
| description | o | text<=20 | short station description |
|
||||
| gps | + | array | GPS: latitude, longitude |
|
||||
| station | + | text | station prefix_number |
|
||||
| station_group | + | array | station group |
|
||||
| station_group | + | array | station_group describes which bike_groups are allowed at the station |
|
||||
| authed | o | text | return 1 if user is authenticated on operator |
|
||||
| gps_radius | + | text | geofencing by meters around station, for bike return. |
|
||||
| uri_operator | + | text | URI of operator-server |
|
||||
| service_tour | o | text | service tour number |
|
||||
| uri_operator | + | text | URI of operator-server |
|
||||
| bike_count | + | text | Amount of available bikes on station |
|
||||
| user_rental_count | + | text | Amount of user rentaled bikes on station |
|
||||
| operator_data | o | object | operator values (see example) |
|
||||
|
||||
|
||||
**station_group** describes which **bike_group** are allowed at the station.
|
||||
Groups are identified by ID. The following groups of bicycles are defined:
|
||||
| Defined group ID's | bike type |
|
||||
| ------ | ------ |
|
||||
| 300101 | Cargobike |
|
||||
| 300103 | Citybike |
|
||||
Keep in mind, each ID is preceded by an operator-prefix. Datatype is array, because each station can have more byke_group
|
||||
|
||||
Example
|
||||
**REST request=stations_available** for authorized users
|
||||
```
|
||||
https://shareeapp-primary.copri-bike.de/APIjsonserver?request=stations_available&authcookie=6103_0f667aa7f234fe317a2705ee89fde0c3_1234567998
|
||||
https://shareeapp-primary.example.tld/APIjsonserver?request=stations_available&authcookie=6103_0f667aa7f234fe317a2705ee89fde0c3_1234567998
|
||||
```
|
||||
|
||||
**response** sharee JSON defaults + **response** multiple station objects
|
||||
|
@ -38,8 +45,8 @@ https://shareeapp-primary.copri-bike.de/APIjsonserver?request=stations_available
|
|||
},
|
||||
"WUE9301" : {
|
||||
"state" : "available",
|
||||
"uri_operator" : "https://shareeapp-wue.copri-bike.de",
|
||||
"description" : "Rieselfeldemo",
|
||||
"uri_operator" : "https://shareeapp-wue.example.tld",
|
||||
"description" : "Cargo and Citybike Station",
|
||||
"operator_data" : {
|
||||
"operator_hours" : "Montag, Mittwoch, Freitag 9-12 Uhr",
|
||||
"operator_logo" : "",
|
||||
|
@ -49,18 +56,16 @@ https://shareeapp-primary.copri-bike.de/APIjsonserver?request=stations_available
|
|||
"operator_color" : "#009699"
|
||||
},
|
||||
"station" : "WUE9301",
|
||||
"authed" : "1",
|
||||
"service_tour" : "WUE2",
|
||||
"station_group" : [
|
||||
"WUE300101"
|
||||
"WUE300101",
|
||||
"WUE300103"
|
||||
],
|
||||
"gps" : {
|
||||
"latitude" : "47.99814334149303",
|
||||
"longitude" : " 7.765779379576922"
|
||||
},
|
||||
"gps_radius" : "100",
|
||||
"bike_count" : "2",
|
||||
"user_rental_count" : "1"
|
||||
"bike_count" : "2"
|
||||
},
|
||||
"WUE9302" : {
|
||||
...
|
||||
|
|
|
@ -23,7 +23,6 @@
|
|||
| uri_operator | + | text | URI of Operator-Server |
|
||||
| lockit_ID | + | text | bluetooth ID |
|
||||
| lockit_GUID | + | text | bluetooth GUID |
|
||||
| authed | + | text | if 1 then authenticated request on operator |
|
||||
| rental_description | + | object | with tarif_elements and rental_info |
|
||||
| bike_type | + | object | describes the bike with some attributes |
|
||||
| smartlock_type | o | object | (under development) describes the smartlock with some attributes |
|
||||
|
@ -50,6 +49,14 @@
|
|||
| engine | o | object | contains engine attributes like "manufacturer" |
|
||||
| battery | o | object | contains smartlock battery attributes. |
|
||||
|
||||
**bike_group** describes at which station defined in **station_group** the bike is allowed.
|
||||
Groups are identified by ID. The following groups of bicycles are defined:
|
||||
| Defined group ID's | bike type |
|
||||
| ------ | ------ |
|
||||
| 300101 | Cargobike |
|
||||
| 300103 | Citybike |
|
||||
Keep in mind, each ID is preceded by an operator-prefix. Data type is array.
|
||||
|
||||
|
||||
Example
|
||||
**REST request=bikes_available** for authorized users
|
||||
|
|
Loading…
Reference in a new issue