Versions Compared

Old Version 406

changes.mady.by.user Jayaraj Purushothaman

Saved on

compared with

New Version 407

changes.mady.by.user Jayaraj Purushothaman

Saved on

Key

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

...

Deck of Cards
idbimCreateProjectFromIFC
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: import 

URL: https://api-stage.bimplus.net/v2/<team_slug>/projects/<project_id>/model/<model_id>/import

Example: https://api-stage.bimplus.net/v2/bimplus/projects/best-project/model/12345/import


Card
labelDescription
 Replace a model in a project by importing SketchUp and IFC files.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created

 

Anchor
slideshowService
slideshowService

Slideshow Service

...

A Slideshow is a group of slides(camera snapshots) attached to a project.

Anchor
createProject
createProject

Create a new slideshow
Deck of Cards
idbimCreateProject
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / 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.

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
 Creates a new slideshow for a project.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
"name" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
"name": "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

 

Anchor
authorizationService
authorizationService

...

Deck of Cards
idbimGetDetailsFromObjectList
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: usersettings/heirarchy/all 

URL: https://api-stage.bimplus.net/v2/<team_slug>usersettings/heirarchy/all 

Example: https://api-stage.bimplus.net/v2/bimplus/usersettings/heirarchy/all

JSON Structure: 

Name

Mandatory / Optional

Type

Description

moduleid

mandatory

guid

Id of the module

userid

mandatory

guid

Id of the user

categoryoptionalstringcategory name (default category is "ObjectNavigator")


Card
labelDescription
 Get all the user hierarchies using the user & module information
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "moduleid": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
    "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
    "category": "ObjectNavigator"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "attribusersettingid": "511d2c35-d7a6-4e76-82f0-172a64c322b6",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Building]",
        "valuename": "onProjectElements_Building",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "909c9802-a339-4a60-8fff-64ea495f6136",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_Electricity]",
        "valuename": "onProjectElements_Electricity",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Length[I]Width",
        "datasmallint": null,
        "revision": null
    },
    {
        "attribusersettingid": "e4ca5278-98da-4809-9582-6815bbab2200",
        "objectid": "1f15c447-e511-4fc1-940b-13639f973c52",
        "module": "3e3b1ae3-8955-4c4e-803e-2d56a4a8e50d",
        "userid": "a612e213-1a6e-4aa2-b032-d5aeb8f31c97",
        "category": "ObjectNavigator",
        "isdefault": false,
        "valuekey": "[onProjectElements_MEP]",
        "valuename": "onProjectElements_MEP",
        "value": "Name[I]Description[I]Division[I]ModelType[I]ElementTyp[I]Weight[I]Length[I]Width",
        "datasmallint": 0,
        "revision": null
    }
]

 

reate a new slideshow