Page History

...

Deck of Cards

id	bimCreateSlideshow

Card

label	HTTP Method

POST

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 slideshowscene

optional

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

label

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.

Card

label	Description

Creates a new slideshow for a project.

Description

Creates a new slideshow for a project.

Card

label	Request

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"
}

Card

label	Response

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",

Card

label	Request

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": {
            "fovcity": 45"Munich",
            "positioncountry": {"Germany"
                "x": 1231.4,
        },
        "ypreferedLanguage": 234.3,
                "z": 3123.7
       "en"
     },
            "quaternioncreated": {
                "x": 0.9,
                "y": 0.7,
         "2014-03-06T09:43:00.0929712Z",
       "zid": 0.7,
                "w": 0.23
            },
    "30f4495a-79d7-48e4-8060-8a52350cfcd9"
}

Anchor

	getSlideshowList
	getSlideshowList

Get the slideshow list from a project

Deck of Cards

id	bimGetSlideshowList

Card

label	HTTP Method

GET

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

Card

label	Description

Get the slideshow list belonging to a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "targetprojectId": {"5cd37c77-d341-4ab2-9f0d-44467955b218",
                "objectId"name": "<GUID>My first slideshow",
        "description": null,
        "positionauthor": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "xemail": 1231.4"jayaraj.purushothaman@gmail.com",
            "firstname": "Jayaraj",
            "ylastname": 234.3"Purushothaman",
                    "zcompany": 3123.7 "Jay Company",
                }"fullname": "Jayaraj Purushothaman",
            }
    "displayname": "Jayaraj Purushothaman [Jay Company]",
    },
        "objectsinfo": {"",
            "selectedgender": ["MR",
                0"phoneWork": "",
                1"phoneHome": "",
                2"fax": "",
                3"mobile": "",
                4"birthDate": "0000-00-00",
            "address": {
   5,
             "street": "Konrad Zuse 6platz",
                7,
                8,
                9
      "streetNr": "1",
      ],
            "transparentzip": ["81829",
                0,
                1"city": "Munich",
                2,
                3,"country": "Germany"
                4},
                5,"preferedLanguage": "en"
                6},
                7"created": "2014-03-06T09:43:00",
                8,"id": "30f4495a-79d7-48e4-8060-8a52350cfcd9"
                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

label	Response

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"
}

...

}
]

Anchor
deleteSlideshowList
deleteSlideshowList

Delete all the slideshows from a project

Deck of Cards

id	bimDeleteSlideshowList

Card

label	HTTP Method

DELETE

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

Card

label	Description

Delete all the slideshows from a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Anchor

	getSlideshowDetails
	getSlideshowDetails

Get details of the slideshow

Deck of Cards

id	bimGetSlideshowDetails

Card

label	HTTP Method

GET

...

Get the slideshow list from a project

Deck of Cards

id	bimGetSlideshowList

Card

label	HTTP Method

GET

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

Card

label	Description

Get the slideshow list belonging to a project.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

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",
        "id": "cdece695-530d-4b54-a413-d30877a15b08"
    }
]

...

Delete all the slideshows from a project

Deck of Cards

id	bimDeleteSlideshowList

Card

label	HTTP Method

DELETE

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

Card

label	Description

Delete all the slideshows from a project

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Get details of the slideshow

Deck of Cards

id	bimGetSlideshowDetails

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

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

Card

label	Description

Get the details of a particular slideshow using its id.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

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-03T15:31:14",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

...

Update the slideshow

Deck of Cards

id	bimUpdateSlideshow

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: slideshows 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

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

label	Description

Get the details of a particular slideshow using its id.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

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-03T15:31:14",
    "id": "ff375edf-5e8c-4b68-a4a1-fec6b943e7d8"
}

Anchor

	updateSlideshow
	updateSlideshow

Update the slideshow

Deck of Cards

id	bimUpdateSlideshow

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

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	mandatory	string	Name of the slideshow

Card

label	Description

Update a specific slideshow using its id.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "projectId": "5cd37c77-d341-4ab2-9f0d-44467955b218",
    "name": "Updating my first slideshow",
    "description": null,
    "author": {
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"
    }
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "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"
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 418

New Version 419

Key

Get the slideshow list from a project

Anchor
deleteSlideshowList
deleteSlideshowList

Delete all the slideshows from a project

Get details of the slideshow

Get the slideshow list from a project

Delete all the slideshows from a project

Get details of the slideshow

Update the slideshow

Update the slideshow

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 418

New Version 419

Key

Get the slideshow list from a project

AnchordeleteSlideshowListdeleteSlideshowList

Delete all the slideshows from a project

Get details of the slideshow

Get the slideshow list from a project

Delete all the slideshows from a project

Get details of the slideshow

Update the slideshow

Update the slideshow

Anchor
deleteSlideshowList
deleteSlideshowList