roko.li/sharee.bike-Wiki
4
0
Fork 0
mirror of https://gitlab.com/t6353/sharee.bike.wiki.git synced 2024-05-08 11:16:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: roko.li:303878b4ba8cd57599a2a9d05f5743f8cc100243
Branches Tags
roko.li:main
...
compare: roko.li:89722c1312435c7dcf6adccb35f3057f060d86fd
Branches Tags
roko.li:main

4 commits
303878b4ba ... 89722c1312

Author SHA1 Message Date
Rainer Gümpelein 89722c1312 Update 5.4. tool request=service_work 2022-12-30 17:55:27 +00:00
Rainer Gümpelein 15390275ca Update 5.3. tool request=service_done 2022-12-30 15:59:13 +00:00
Rainer Gümpelein cb9d72141f Update 3.5. pri request=bikes_available 2022-12-30 14:40:38 +00:00
Rainer Gümpelein a13a9cbccb Update 5.2. tool request=bikes_all 2022-12-30 14:39:45 +00:00
4 changed files with 63 additions and 28 deletions
Show stats Expand all files Collapse all files

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

@ -47,7 +47,7 @@
**smartlock_type** JSON Object
| key | Required | Format | Comment |
| ------------------ | -------- | ---------------- | -------------------------- |
| system | o | text | ex. "Ilockit" |
| engine | o | object | contains engine attributes like "manufacturer" |
| battery | o | object | contains smartlock battery attributes. |
@ -121,7 +121,9 @@ https://sharee-primary.example.tld/APIjsonserver?request=bikes_available&authcoo
"uri_operator" : "https://shareeapp-op.example.tld",
"system" : "Ilockit",
"smartlock_type" : {
"system" : "Ilockit",
"engine" : {
"manufacturer" : "Ilockit"
},
"battery" : {
"charge_current_percent" : "37"
}

6
5.2.-tool-request=bikes_all.md
View file

@ -40,7 +40,7 @@
**smartlock_type** JSON Object
| key | Required | Format | Comment |
| ------------------ | -------- | ---------------- | -------------------------- |
| system | o | text | ex. "Ilockit" |
| engine | o | object | contains engine attributes like "manufacturer" |
| battery | o | object | contains smartlock battery attributes. Look at example response |
@ -60,7 +60,9 @@ https://shareeapp-primary.example.tld/APIjsonserver?request=bikes_all&authcookie
"FR4781" : {
"bike" : "FR4781",
"smartlock_type" : {
"system" : "Ilockit",
"engine" : {
"manufacturer" : "Ilockit"
},
"battery" : {
"charge_current_percent" : "37"
}

35
5.3.-tool-request=service_done.md
View file

@ -29,15 +29,19 @@ Parameter | Required | Format | Comment |
Example
**REST request** insert/update work_id with work_val
```
https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_done&bike=FR_1541&work_id=int01&work_val=1&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
https://shareeapp-operator.example.tld/APIjsonserver?request=service_done&bike=FR1541&work_id=int01&work_val=1&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
```
**REST request** update "Aufgaben" by service_id
```
https://shareeapp-operator.example.tld/APIjsonserver?request=service_done&bike=FR1541&work_id=txt01&work_val=%3A%3Aerledigt%3A%3A&service_id=41519&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
```
**REST request** update bike for redistribution to another station
```
https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_done&bike=FR_1541&work_id=station&work_val=FR_101&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
https://shareeapp-operator.example.tld/APIjsonserver?request=service_done&bike=FR1541&work_id=station&work_val=FR_101&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
```
**REST request** update bike state to available OR maintanance OR defect
```
https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_done&bike=FR_1541&work_id=state&work_val=maintanance&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
https://shareeapp-operator.example.tld/APIjsonserver?request=service_done&bike=FR1541&work_id=state&work_val=maintanance&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
```
**response** returns last bike/station service-work values by JSON-Objects depending on *bike* OR *station* number
@ -59,19 +63,19 @@ https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_done&bike=FR_
"tariff_info_html" : "site/tariff_info.html",
"impress_html" : "site/impress.html",
"user_group" : [
"FR_300001",
"FR_300029"
"FR300001",
"FR300029"
],
"user_tour" : [
"FR_1",
"FR_2"
"FR1",
"FR2"
],
"uri_operator" : "https://shareeapp-fr01.copri-bike.de",
"uri_operator" : "https://shareeapp-operator.example.tld",
"service_template" : "401",
"response_state" : "OK, service_update",
"clearing_cache" : "0",
"uri_primary" : "https://shareeapp-primary.copri-bike.de",
"FR_1541" : {
"uri_primary" : "https://shareeapp-primary.example.tld",
"FR1541" : {
"int15" : {
"owner" : "0",
"mtime" : "",
@ -229,15 +233,16 @@ https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_done&bike=FR_
"work_name" : "Achsschrauben"
},
"txt01" : {
"work_id" : "txt01",
"user_name" : "",
"work_name" : "Aufgaben",
"interval" : "0",
"work_val" : "Speiche locker\n",
"time_over" : "0",
"service_id" : "0",
"service_id" : "41514",
"user_name" : "copri admin",
"work_id" : "txt01",
"mtime" : "2022-11-29 10:40:46.186788+01",
"service_type" : "0",
"mtime" : "",
"owner" : "0"
"owner" : "18520"
},
"int12" : {
"user_name" : "",

44
5.4.-tool-request=service_work.md
View file

@ -8,7 +8,9 @@
| bike | o /+ | text | bike prefix+number |
| station | o /+ | text | station prefix+number |
**response** bike OR station prefix+number with work-values by JSON-Objects
**response** bike OR station prefix+number with work-values by JSON-Objects.
JSON-objects are described by the internal-data-key.
To be able to process several "txt01" tasks, if there is more than one open task, a counter separated by a _ is added to the internal-data-key.
| Parameter | Required | Format | Comment |
| -------------- | -------- | -------- | -------------------------------------- |
@ -26,7 +28,7 @@
Example
**REST request** read last work values by bike or station prefix+number
```
https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_work&bike=FR_1541&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
https://shareeapp-operator.example.tld/APIjsonserver?request=service_work&bike=FR1541&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_34567890
```
**response**
@ -40,19 +42,19 @@ https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_work&bike=FR_
"clearing_cache" : "0",
"impress_html" : "site/impress.html",
"agb_checked" : "1",
"uri_primary" : "https://shareeapp-primary.copri-bike.de",
"uri_primary" : "https://shareeapp-primary.example.tld",
"response" : "service_work",
"copri_version" : "4.0.1.3",
"lang" : "DE",
"user_group" : [
"FR_300001",
"FR_300029"
"FR300001",
"FR300029"
],
"user_tour" : [
"FR_1",
"FR_2"
"FR1",
"FR2"
],
"uri_operator" : "https://shareeapp-fr01.copri-bike.de",
"uri_operator" : "https://shareeapp-operator.example.tld",
"service_template" : "401",
"privacy_html" : "site/privacy.html",
"authcookie" : "6103_f782a208d9399291ba8d086b5dcc2509_34567890",
@ -60,7 +62,31 @@ https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=service_work&bike=FR_
"user_id" : "javaminister@example.tld",
"debuglevel" : "1",
"response_state" : "OK: nothing todo",
"FR_1541" : {
"FR1541" : {
"txt01" : {
"time_over" : "0",
"work_val" : "Achtung, Fahrradschloss Ladung unter 22%",
"service_id" : "41509",
"interval" : "0",
"work_name" : "Aufgaben",
"service_type" : "0",
"mtime" : "2022-10-28 15:33:16.817532+02",
"owner" : "188",
"user_name" : "sys API",
"work_id" : "txt01"
},
"txt01_2" : {
"work_name" : "Aufgaben",
"interval" : "0",
"work_val" : "Schutzblech fixieren",
"time_over" : "0",
"service_id" : "41512",
"user_name" : "Christian Fischer",
"work_id" : "txt01",
"mtime" : "2022-11-28 20:14:42.912067+01",
"service_type" : "0",
"owner" : "21254"
},
"int09" : {
"work_name" : "Reifenluftdruck",
"service_id" : "0",