webssphh_restful_service
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
webssphh_restful_service [2016/07/23 14:09] – [WebSSPHHService] 100.3.200.49 | webssphh_restful_service [2023/09/22 16:50] (current) – [WebSSPHH RESTful Service] microwerx | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== WebSSPHH RESTful Service ====== | ====== WebSSPHH RESTful Service ====== | ||
+ | [[start]] | ||
===== WebSSPHHService ===== | ===== WebSSPHHService ===== | ||
- | '' | + | '' |
- | + | ||
- | Parameters: | + | |
- | + | ||
- | '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
| parameter | data type | values | definition | | | parameter | data type | values | definition | | ||
- | | a | string| s | SELECT RECORD | + | | a | string| s\\ u\\ i\\ d | SELECT RECORD |
- | | | | u | UPDATE RECORD | + | |
- | | | | i | INSERT RECORD | + | |
- | | | | d | DELETE RECORD | | + | |
| token | string | [\w\d]+ | A security token allowing authorized users only | | | token | string | [\w\d]+ | A security token allowing authorized users only | | ||
| projects | none | none | Returns a JSON array of projects | | | projects | none | none | Returns a JSON array of projects | | ||
Line 27: | Line 16: | ||
| project| number | 1 - 1048576 | Returns a JSON object with the project properties | | | project| number | 1 - 1048576 | Returns a JSON object with the project properties | | ||
| scene | number | 1 - 1048576 | Returns a JSON object with the scene properties. This requires the '' | | scene | number | 1 - 1048576 | Returns a JSON object with the scene properties. This requires the '' | ||
- | | object | number | 1 - 1048576 | Returns a JSON object with the object properties. | + | | object | number | 1 - 1048576 | Returns a JSON object with the object properties. This requires the '' |
+ | |||
+ | ===== Schemas ===== | ||
+ | |||
+ | ==== Projects ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | { " | ||
+ | { " | ||
+ | ... | ||
+ | ] | ||
+ | </ | ||
+ | |||
+ | ==== Scenes ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | { " | ||
+ | { " | ||
+ | ... | ||
+ | ] | ||
+ | </ | ||
+ | |||
+ | ==== Objects ==== | ||
+ | <code javascript> | ||
+ | " | ||
+ | { " | ||
+ | { " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Project ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Scene ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Object ==== | ||
+ | |||
+ | The types of objects are | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Common Types of Properties ===== | ||
+ | |||
+ | ==== Special Types ==== | ||
+ | |||
+ | ^Typename | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | ==== Normal Types ==== | ||
+ | |||
+ | === Object === | ||
+ | |||
+ | ^Typename ^JSON/Type | | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | === Point Light === | ||
+ | ^Typename ^JSON/Type | | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' |
webssphh_restful_service.1469300941.txt.gz · Last modified: 2016/07/23 14:09 by 100.3.200.49