Slideshow Service
- Create a new slideshow
- Get the slideshow list from a project
- Delete all the slideshows from a project
- Get details of the slideshow
- Update the slideshow
- Delete the slideshow
- Create a new slide for a slideshow
- Get the slide list from a slideshow
- Get the details of a slide
- Update the details of a slide
- Delete a slide from a slideshow
- Create a thumbnail for a slideshow
- Download the thumbnail from a slideshow
- Create a thumbnail for a slide
- Download the thumbnail from a slide
- Working with attachments/comments/hyperlinks belonging to a slide
Slideshow Service
A Slideshow is a group of slides(camera snapshots) attached to a project.
Create a new slideshow
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 |
| description | optional | string | Description of the slideshow |
| projectId | will be ignored | string | The id of the project to which the slideshow belongs |
| author | will be ignored | object (user) | Information about the user who has created the slideshow |
| created | will be ignored | string (date) | Creation date of the slideshow |
| id | will be ignored | string (id) | Id of the slideshow |
POST
Creates a new slideshow for a project.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"name": "My first slideshow"
}
Status
Status: 201 Created
JSON
{
"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-06T09:43:00.0929712Z",
"id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}
Get the slideshow list from a project
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
GET
Get the slideshow list belonging to a project.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
[
{
"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-06T09:43:00",
"id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}
]
Delete all the slideshows from a project
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
DELETE
Delete all the slideshows from a project
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
Get details of the slideshow
Resource: slideshows/<slideshow_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2
GET
Get the details of a particular slideshow using its id.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
{
"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-03T15:31:14",
"id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Update the slideshow
Resource: slideshows/<slideshow_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the slideshow |
| description | optional | string | Description of the slideshow |
| projectId | optional | string | The id of the project to which the slideshow belongs |
| author | will be ignored | object (user) | Information about the user who has created the slideshow |
| created | will be ignored | string (date) | Creation date of the slideshow |
| id | will be ignored | string (id) | Id of the slideshow |
PUT
Update a specific slideshow using its id. Only name and description can be updated.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"name": "Updating my first slideshow",
"description": null
}
Status
Status: 200 OK
JSON
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": null,
"firstname": null,
"lastname": null,
"company": null,
"fullname": "",
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"created": "0001-01-01T00:00:00",
"id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Delete the slideshow
Resource: slideshows/<slideshow_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8
DELETE
Delete a particular slideshow using its id.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
Create a new slide for a slideshow
Resource: slideshows/<slideshow_id>/slides
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the slide |
| description | optional | string | Description of the slide |
| slideInfo | optional | string | |
| 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. |
| author | will be ignored | object (user) | Information about the user who has created the slide |
| created | will be ignored | string (date) | Creation date of the slide |
| changed | will be ignored | string (date) | Date of last modification |
| id | will be ignored | string (id) | Id of the slide |
| index | will be ignored | integer | Order of the slides (Starts with 1) |
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
}
]
}
POST
Creates a new slide for a specific slideshow.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"name": "My first slide",
"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
}
]
}
}
Status
Status: 201 Created
JSON
{
"name": "My first slide",
"description": null,
"slideInfo": "",
"index": 1,
"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
}
]
},
"created": "2014-03-06T09:52:58.4376633Z",
"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"
},
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Get the slide list from a slideshow
Resource: slideshows/<slideshow_id>/slides
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/slides
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/30f4495a-79d7-48e4-8060-8a52350cfcd9/slides
GET
Get the slide list belonging to a slideshow
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
[
{
"name": "My first slide",
"description": null,
"slideInfo": "",
"index": 1,
"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
}
]
},
"created": "2014-03-06T09:52:58",
"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"
},
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
]
Get the details of a slide
Resource: slides/<slide_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slides/60c23ad7-c4b6-4387-b273-1dff2b1dc895
GET
Get the details of a particular slide using its id.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
JSON
{
"name": "My first slide",
"description": null,
"slideInfo": "",
"index": 1,
"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
}
]
},
"created": "2014-03-06T09:52:58",
"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"
},
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Update the details of a slide
Resource: slides/<slide_id>
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slides/586b02be-43b8-4e27-b698-e067e85e38e2
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
|---|---|---|---|
name |
optional |
string |
Name of the slideshow |
| description | optional | string | Description of the slideshow |
| projectId | optional | string | The id of the project to which the slideshow belongs |
| author | will be ignored | object (user) | Information about the user who has created the slideshow |
| created | will be ignored | string (date) | Creation date of the slideshow |
| id | will be ignored | string (id) | Id of the slideshow |
| index | optional | integer | Order of the slide (Starts with 1) |
PUT
Update a specific slideshow using its id.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
JSON
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slide",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
}
}
Status
Status: 200 OK
JSON
{
"projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
"name": "Updating my first slideshow",
"description": null,
"author": {
"id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
"email": null,
"firstname": null,
"lastname": null,
"company": null,
"fullname": "",
"displayname": null,
"info": null,
"gender": null,
"phoneWork": null,
"phoneHome": null,
"fax": null,
"mobile": null,
"birthDate": null,
"address": {
"street": "",
"streetNr": "",
"zip": "",
"city": "",
"country": ""
},
"preferedLanguage": null
},
"created": "0001-01-01T00:00:00",
"id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}
Delete a slide from a slideshow
Resource: slides/slide
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>
Example: https://api-stage.bimplus.net/v2/bimplus/slides/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8
DELETE
Delete a particular slide using its id.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status
Status: 200 OK
Create a thumbnail for a slideshow
Resource: slides/<slide_id>/thumbnail
URL: https://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id>/thumbnail
Example: https://api-stage.bimplus.net/v2/bimplus/slideshows/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail
POST
Creates or uploads a thumbnail to a slideshow.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status
Status: 201 Created
JSON
{
"fileName": "Slideshow1.png",
"type": "image/png",
"size": 21320,
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Download the thumbnail from a slideshow
Resource: slide/<slide_id>/thumbnail/download
URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/<thumbnail_id>
Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
GET
Downloads the thumbnail of a slideshow.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status
Status: 200 OK
Create a thumbnail for a slide
Resource: slides/<slide_id>/thumbnail
URL: https://api-stage.bimplus.net/v2/<team_slug>/slides/<slide_id>/thumbnail
Example: https://api-stage.bimplus.net/v2/bimplus/slides/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail
POST
Creates or uploads a thumbnail to a slide.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status
Status: 201 Created
JSON
{
"fileName": "Slide1.png",
"type": "image/png",
"size": 21320,
"id": "60c23ad7-c4b6-4387-b273-1dff2b1dc895"
}
Download the thumbnail from a slide
Resource: slide/<slide_id>/thumbnail/download
URL: https://api-stage.bimplus.net/v2/<team_slug>/thumbnail/>thumbnail_id>
Example: https://api-stage.bimplus.net/v2/bimplus/thumbnail/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e
GET
Downloads the thumbnail of a slide.
Headers
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: multipart/form-data
Status
Status: 200 OK
Working with attachments/comments/hyperlinks belonging to a slide
Please use the Bimplus Object Service for working with attachments, comments or hyperlinks belonging to a slide
