| Card |
|---|
| default | true |
|---|
| label | URL / Resource / JSON Structure |
|---|
| | Resource: slideshows URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows Example: https://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows JSON Structure: Name | Mandatory / Optional | Type | Description |
|---|
name | mandatory | string | Name of the slideshow | scene | optional | object | A JSON string which includes viewMode(transparent or not), camera values & positions, related objects, clipping plane, topology & layer details. An example template is specified below. Please remember, the server will process the scene information as a json string and hence the client has to take care on the information that is stored & retrieved. |
An example scene template: "scene": { "viewMode": "transparent", "camera": { "fov": 45, "position": { "x": 1231.4, "y": 234.3, "z": 3123.7 }, "quaternion": { "x": 0.9, "y": 0.7, "z": 0.7, "w": 0.23 }, "target": { "objectId": "<GUID>", "position": { "x": 1231.4, "y": 234.3, "z": 3123.7 } } }, "objects": { "selected": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "transparent": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "hidden": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "clippingPlane": { "axis": "x", "distance": -123.5, "selected": false }, "topology": [ [ "<nodeId>", "<disciplineId>" ], [ "<nodeId2>", "<disciplineId2>" ] ], "layers": [ { "id": "<GUID>", "divisionTopologyId": "<GUID>", "visible": true, "transparent": false } ] } |
| Card |
|---|
| | Creates a new slideshow for a project. |
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Headers |
|---|
| lang | xml |
|---|
| Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"name": "My first slideshow",
"scene": {
"viewMode": "transparent",
"camera": {
"fov": 45,
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
},
"quaternion": {
"x": 0.9,
"y": 0.7,
"z": 0.7,
"w": 0.23
},
"target": {
"objectId": "<GUID>",
"position": {
"x": 1231.4,
"y": 234.3,
"z": 3123.7
}
}
},
"objects": {
"selected": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"transparent": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"hidden": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
},
"clippingPlane": {
"axis": "x",
"distance": -123.5,
"selected": false
},
"topology": [
[
"<nodeId>",
"<disciplineId>"
],
[
"<nodeId2>",
"<disciplineId2>"
]
],
"layers": [
{
"id": "<GUID>",
"divisionTopologyId": "<GUID>",
"visible": true,
"transparent": false
}
]
}
} |
|
| Card |
|---|
| | Code Block |
|---|
| borderColor | Green |
|---|
| title | Status |
|---|
| lang | xml |
|---|
| Status: 201 Created
|
| Code Block |
|---|
| borderColor | Red |
|---|
| title | JSON |
|---|
| lang | xml |
|---|
| {
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "My first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": "jayaraj.purushothaman@gmail.com",
"firstname": "Jayaraj",
"lastname": "Purushothaman",
"company": "Jay Company",
"fullname": "Jayaraj Purushothaman",
"displayname": "Jayaraj Purushothaman [Jay Company]",
"info": "",
"gender": "MR",
"phoneWork": "",
"phoneHome": "",
"fax": "",
"mobile": "",
"birthDate": "0000-00-00",
"address": {
"street": "Konrad Zuse platz",
"streetNr": "1",
"zip": "81829",
"city": "Munich",
"country": "Germany"
},
"preferedLanguage": "en"
},
"created": "2014-03-03T12:50:01.4612622Z",
"id": "cdece695-530d-4b54-a413-d30877a15b08"
} |
|
|