diff --git a/3.4.-request=stations_available.md b/3.4.-request=stations_available.md new file mode 100644 index 0000000..b22ca41 --- /dev/null +++ b/3.4.-request=stations_available.md @@ -0,0 +1,55 @@ +### request=stations_available + +Query of the available stations depending on the rental bike groups assigned to the registered user. + +**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 | +| 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** one station object + +``` + "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" + }, + +``` \ No newline at end of file