Page History

Note
This web page is under construction. The JSON Request and Response Reply (Request and Response Reply tab) for the API calls are not complete.

...

Deck of Cards

id	bimCreateProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	date	Creation date of the project

Card

label	Description

Creates a new project.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
"name:" : "Your Awesome Building",
"shortDescr" : "Example for creating a project"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

borderColor	Red
lang	xml
title	JSON

{
"name": null
shortDescr "Your Awesome Building",
"shortDescr": "Example for creating a project",
"thumbnail": null,
"created": "2013-06-01T10:05:00",
"changed": null,
"disciplines": null,
"id": "ee1ef5970d2ce2cc-33b23588-403745d6-865ea59a-bc4e26deaccaf6b89ebed34e"
}

Get the Project List

Deck of Cards

id	bimGetProjectList

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: https://api.bimplus.net/v2/<team>/projects

Example: https://api.bimplus.net/v2/bimplus/projects

Card

label	Description

Gets the available project list with main properties.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON


[3]
0:    {
        "id": "c8c8e6f2586b02be-449543b8-484c4e27-929db698-0049f1f9d4ffe067e85e38e2",
        "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}

...

Get the Project Properties

...

,
        "shortDescr": "Hey, i am your favourite test entry",
        "thumbnail": null,
        "created": "2013-05-01T09:33:18",
        "changed": "2013-05-01T09:33:18"
    },
    {
        "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e",
        "name": "Your Awesome Building",
        "shortDescr": "Example for creating a project",
        "thumbnail": null,
        "created": "0001-01-01T00:00:00",
        "changed": "0001-01-01T00:00:00"
    },
    {
        "id": "4e87944a-a477-4e4c-862e-e723dcb43066",
        "name": "UC_Fly-over Kerensheide",
        "shortDescr": null,
        "thumbnail": null,
        "created": "2013-05-10T07:13:38",
        "changed": "2013-05-16T07:34:56"
    }
]

...

Get the Project Properties

...

Deck of Cards

id	bimGetProjectProp

Card

label	Implementation Status

Image Added Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Get all the project properties of a project using its id.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON


{
    "name": "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang",
    "shortDescr": "Hey, i am your favourite test entry",
    "thumbnail": null,
    "created": null,
    "changed": null,
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "63b069d2-81df-4418-91de-8a954fa12924",
            "name": "ID_DesignModel_Timber",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "30114b52-bc05-47c1-80b5-c7d5485d5840",
            "name": "ID_FinishModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        },
        {
            "id": "09e623d4-1e12-4a77-b358-ea1d0b28e4a7",
            "name": "ID_RoomModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "id": "586b02be-43b8-4e27-b698-e067e85e38e2"
}

Deck of Cards

id	bimGetProjectProp

Card

label	Implementation Status

Image Removed Service available !

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<team>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects/c8c8e6f2-4495-484c-929d-0049f1f9d4ff

Card

label	Description

Get all the project properties of a project using its id.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers


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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
disciplines: [0]
name: null
shortDescr: null
thumbnail: null
created: "0001-01-01T00:00:00"
changed: "0001-01-01T00:00:00"
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
}

Update the project

Deck of Cards

id	bimUpdateProject

Card

label	Implementation Status

Service available !

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: https://api.bimplus.net/v2/<company>/projects/<project_id>

Example: https://api.bimplus.net/v2/bimplus/projects

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	mandatory	guid	id of the project
name	optional	string	Name of the project
shortDescr	optional	string	Short description of the project
created	optional	date	Creation date of the project
changed	optional	date	Changed date of the project

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

.

Card

label	Description

Update or replace a specified existing project with a new one.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Card

label	ResponseRequest

Code Block

borderColor	Green
lang	xml
title	StatusHeaders

StatusAuthorization: 200 OK BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

[3]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "2d703abe-b4f9-407c-af53-a39c5b7ba872"
name: "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "c480cc54-aec4-4bef-8d35-93bb090e1aba"
name: "0811-Wohnhaus Kraus - Carport1"
}"shortDescr" : "Updating the project"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status


Status: 200 OK

Create an issue in the project

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Get the Project List

Get the Project Properties

Get the Project Properties

Update the project

Create an issue in the project