Versions Compared

Key

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

...

Deck of Cards
idbimCreateModel
Card
labelHTTP Method
 POST
Card
defaulttrue
labelURL / Resource / JSON Structure
 

Resource: divisions 

URL: http://api-dev.bimplus.net/v2/<team_slug>/projects/<project_id>/divisions

Examplehttp://api-dev.bimplus.net/v2/bimplus/projects/743a24f9-baaa-41b9-90b3-91717238043c/divisions

JSON Structure

Name

Mandatory / Optional

Type

Description

name

mandatory

string

Name of the project

shortDescr

optional

string

Short description of the project

created

will be ignored

string (date)

Creation date of the project

Card
labelDescription
 Creates a new model.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
 "name" : "YourModel Awesome BuildingD", 
 "shortDescrdescription" : "ExampleCreating fora creatingmodel avia projectAPI"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 201 Created
Code Block
borderColorRed
titleJSON
langxml
{
    "name": "YourModel Awesome BuildingD",
    "shortDescrdescription": "ExampleCreating fora creatingmodel avia projectAPI",
"thumbnail": null,
"created    "projectId": "2013-06-01T10:05:00743a24f9-baaa-41b9-90b3-91717238043c",
"changed": null,
"disciplines": null,
    "id": "0d2ce2ccafbb314f-3588fdde-45d643e7-a59a9a49-f6b89ebed34e90e16c1a6131"
}


Anchor
getModels
getModels

Get the list of existing models inside a project

...

Deck of Cards
idbimUpdateProject
Card
labelHTTP Method
 PUT
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: divisions/<division_id>

URLhttp://api-dev.bimplus.net/v2/<team_slug>/divisions/<division_id>

Examplehttp://api-dev.bimplus.net/v2/bimplus-gmbh/divisions/e687b45b-d90d-4361-94ab-baf269588c0a

JSON Structure

Name

Mandatory / Optional

Type

Description

name

optional

string

Name of the project

shortDescr

optional

string

Short description of the project

created

will be ignored

string (date)

Creation date of the project

changed

will be ignored

string (date)

Changed date of the project

Card
labelDescription
 Update or replace a specified existing model with a new one.
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
titleJSON
langxml
{
    "properties": {
        "MainFloorArea": "456m²",
        "Architect": {
            "name": "NemetschekTech.GmbH",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "city": "Munich",
            "zip": "81829",
            "street": "Konrad-Zuse-Platz1"
        },
        "Customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "city": "New Jersy",
            "zip": "08201"
        }
    }
}
"Model D", 
 "description":"Updating the model D"
}
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK

...