Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
Column
width25%

Import Service


Column
width25%

Slideshow Service


Column
width50%

 

...

Deck of Cards
idbimUpdateSlideshow
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slideshows/<slideshow_id>

URLhttps://api-stage.bimplus.net/v2/<team_slug>/slideshows/<slideshow_id> 

Examplehttps://api-stage.bimplus.net/v2/bimplus/slideshows/586b02be-43b8-4e27-b698-e067e85e38e2

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
labelDescription
 Update a specific slideshow using its id.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "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"
}
Anchor
deleteSlideshow
deleteSlideshow
Delete all the slideshows from a project
Deck of Cards
idbimDeleteUser
Card
labelHTTP Method
 DELETE
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: slideshows

URLhttps://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/slideshows/<slideshow_id>

Examplehttps://api-stage.bimplus.net/v2/bimplus/projects/5cd37c77-d341-4ab2-9f0d-44467955/slideshows/ff375edf-5e8c-4b68-a4a1-fec6b943e7d8

Card
labelDescription
 Delete a particular slideshow using its id.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

 

Anchor
authorizationService
authorizationService

...