roko.li/sharee.bike-Wiki
5
0
Fork 0
mirror of https://gitlab.com/t6353/sharee.bike.wiki.git synced 2024-12-22 15:46:26 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update 3.5. pri request=bikes_available

Browse source
This commit is contained in:
Rainer Gümpelein 2022-12-29 10:05:13 +00:00
parent 21b85fc3df
commit 56be95deb5
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
3.5.-pri-request=bikes_available.md
View file

@ -14,21 +14,19 @@
| -------------- | -------- | -------- | -------------------------------------- | | -------------- | -------- | -------- | -------------------------------------- |
| state | + | text | bike available state | | state | + | text | bike available state |
| lock_state | + | text | bike smartlock locking state | | lock_state | + | text | bike smartlock locking state |
| station_state | o | text | station smartlock locking state |
| service_state | o | text | service state for maintanance |
| bike_charge | o | text | bike akku capacity |
| description | o | text | short bike description | | description | o | text | short bike description |
| bike | + | text | bike prefix+number | | bike | + | text | bike prefix+number |
| gps | + | array | GPS: latitude, longitude | | gps | + | array | GPS: latitude, longitude |
| station | + | text | station prefix+number | | station | + | text | station prefix+number |
| bike_group | + | array | bike group | | bike_group | + | array | bike group |
| system | + | text>=1 | bike lock system | | system | + | text | bike lock system |
| uri_operator | + | text | URI of Operator-Server | | uri_operator | + | text | URI of Operator-Server |
| lockit_ID | + | text | bluetooth ID | | lockit_ID | + | text | bluetooth ID |
| lockit_GUID | + | text | bluetooth GUID | | lockit_GUID | + | text | bluetooth GUID |
| authed | + | text | if 1 then authenticated request on operator | | authed | + | text | if 1 then authenticated request on operator |
| rental_description | + | object | with tarif_elements and rental_info | | rental_description | + | object | with tarif_elements and rental_info |
| bike_type | + | object | describes the bike with some attributes | | bike_type | + | object | describes the bike with some attributes |
| smartlock_type | + | object | (under development) describes the smartlock with some attributes |
**rental_description** JSON Object **rental_description** JSON Object
| key | Required | Format | Comment | | key | Required | Format | Comment |
@ -46,6 +44,12 @@
| engine | o | object | contains engine attributes like "manufacturer" | | engine | o | object | contains engine attributes like "manufacturer" |
| battery | o | object | contains bike battery attributes. "hidden=0" means not in App visible. "backend_accessible=0" means no bike charge API available | | battery | o | object | contains bike battery attributes. "hidden=0" means not in App visible. "backend_accessible=0" means no bike charge API available |
**smartlock_type** JSON Object
| key | Required | Format | Comment |
| ------------------ | -------- | ---------------- | -------------------------- |
| system | o | text | ex. "Ilockit" |
| battery | o | object | contains smartlock battery attributes. |
Example Example
**REST request=bikes_available** for authorized users **REST request=bikes_available** for authorized users