webssphh_restful_service
This is an old revision of the document!
Table of Contents
WebSSPHH RESTful Service
WebSSPHHService
service.php
| parameter | data type | values | definition |
| a | string | s u i d | SELECT RECORD (works with GET or POST) UPDATE RECORD (works with POST only) INSERT RECORD (works with POST only) DELETE RECORD (works with GET or POST |
| token | string | [\w\d]+ | A security token allowing authorized users only |
| projects | none | none | Returns a JSON array of projects |
| scenes | none | none | Returns a JSON array of scenes in the current project. This requires the project parameter to be set |
| objects | none | none | Returns a JSON array of objects in the current project. This requires the project parameter to be set |
| sobjects | none | none | Returns a JSON array of objects in the current scene. This requires the scene parameter to be set. |
| 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 project parameter to be set. |
| object | number | 1 - 1048576 | Returns a JSON object with the object properties. This requires the project parameter to be set. |
Schemas
Projects
"projects" : [ { "id" : number, "name" : string }, // Project { "id" : number, "name" : string }, // Project ... ]
Scenes
"scenes" : [ { "id" : number, "name" : string }, // Scene { "id" : number, "name" : string }, // Scene ... ]
Objects
"objects" : { { "id" : number, "name" : string, "type" : string }, // Object { "id" : number, "name" : string, "type" : string }, // Object ... }
Project
"project" : { "id" : number, // PK "name" : string, // Project Name "desc" : string, // Description "key1" : json, // Property 1 "key2" : json, // Property 2 ... }
Scene
"scene" : { "id" : number, // PK "name" : string, // Name of Scene "key1" : json, // Property 1 "key2" : json, // Property 2 ... }
Object
The types of objects are
cameraenvironmentpointlightmeshspheremtllibrenderconfig
"object" : { "id" : number, // PK "name" : string, // Name of the object "type" : string, // Type of the object "key1" : json, // Property 1 "key2" : json, // Property 2 ... }
Common Types of Properties
Special Types
| Typename | JSON |
|---|---|
AffineMatrix4 | [a11, a12, a13, a14, a21, a22, …, a33, a34] |
Matrix4 | [a11, a12, a13, a14, a21, a22, …, a43, a44] |
Vector2 | [x, y] |
Vector3 | [x, y, z,] |
Vector4 | [ x, y, z, w ] |
Quaternion | [a, b, c, d] |
Normal Types
Object
| Typename | JSON/Type |
|---|---|
worldMatrix | Matrix4 |
usemtl | string |
mesh | string |
Point Light
| Typename | JSON/Type |
|---|---|
worldMatrix | Matrix4 |
position | Vector4 |
radius | number |
E0 | Color3 |
webssphh_restful_service.1469303741.txt.gz · Last modified: 2016/07/23 14:55 by 100.3.200.49