mirror of
https://gitlab.com/t6353/sharee.bike.wiki.git
synced 2024-11-14 22:46:29 +01:00
2.9 KiB
2.9 KiB
request=stations_available
request GET of the available stations depending on the rental bike groups assigned to the registered user.
| key | Required | Format | Comment |
|---|---|---|---|
| authcookie | + | text>=8 | unique encrypted key OR merchant_id |
| station | o | text | station prefix+number |
response list of stations by JSON-Objects
| key | Required | Format | Comment |
|---|---|---|---|
| state | + | text>=8 | available-state |
| description | o | text<=20 | short station description |
| gps | + | array | GPS: latitude, longitude |
| station | + | text | station prefix_number |
| station_group | + | array | station group |
| 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 |
| 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) |
Example REST request=stations_available for authorized users
https://shareeapp-primary.copri-bike.de/APIjsonserver?request=stations_available&authcookie=6103_0f667aa7f234fe317a2705ee89fde0c3_1234567998
response sharee JSON defaults + response multiple station objects
{
"shareejson" : {
***sharee JSON defaults***
},
"WUE9301" : {
"state" : "available",
"uri_operator" : "https://shareeapp-wue.copri-bike.de",
"description" : "Rieselfeldemo",
"operator_data" : {
"operator_hours" : "Montag, Mittwoch, Freitag 9-12 Uhr",
"operator_logo" : "",
"operator_name" : "Test GmbH",
"operator_email" : "hotline@wuerzburg.demo",
"operator_phone" : "09876-122222",
"operator_color" : "#009699"
},
"station" : "WUE9301",
"authed" : "1",
"service_tour" : "WUE2",
"station_group" : [
"WUE300101"
],
"gps" : {
"latitude" : "47.99814334149303",
"longitude" : " 7.765779379576922"
},
"gps_radius" : "100",
"bike_count" : "2",
"user_rental_count" : "1"
},
"WUE9302" : {
...
}