Page History

...

Newwindowlink
title Bimplus portal
url http://www-dev.bimplus.net
is the first place of contact of the user/developer for using the Bimplus platform(development version). The production version of the portal can be found under
Newwindowlink
title shop
url https://www.bimplus.net/en/products/
where you can purchase different editions of Bimplus cloud platform.
Newwindowlink
title Here
url https://www.bimplus.net/en/Home-oxid/bim-Apps/
you can also find a few critical foundation apps like the Bimplus Explorer, Bimplus Viewer and Bimplus Problem Spotter. The portal takes care of the user registration(developer registration) as well.
The Bimplus API(development version url : http://api-dev.bimplus.net/v2) provides an interface for accessing the building information and models. It connects the building project information to a vast number of developers providing innovative Apps / applications that can operate on the building models and information.

...

Gliffy Diagram

size	L
name	US_Register_Compliance

Please register register
Newwindowlink
title here
url http://www-stagedev.bimplus.net
for for accessing the Bimplus resources and become a Bimplus compliant developer and a partner. You will receive an authentication token after the registration.
A Team is a tenant/company which work on the projects. The team has to be specified and setup through the the
Newwindowlink
title bimplus
url http://www-stagedev.bimplus.net
portal portal as so called called
Newwindowlink
title slugs
url http://en.wikipedia.org/wiki/Clean_URL#Slug/URL
to to present a a
Newwindowlink
title clean URL
url http://en.wikipedia.org/wiki/Clean_URL/
. The team slug will be used to know which tenant database to work on.
Using the authentication token and the team slug, you can start working with the building projects which you are a member of, using our Bimplus api.
Please find a quick start tutorial tutorial
Newwindowlink
title here
url 1.2+Quick+Start
.

...

Please use the Bimplus Team Management Service (POST httpshttp://api-dev.bimplus.net/v2/teams) for creating a team. This will basically create a data storage for the team. See in the Request/Response tab where we have created the "best-company" team. Also, please note that the team slug "best-company" will be part of the subsequent requests for accessing the resources and performing the desired actions on them.

Create a new user using the Bimplus User Management Service(POST httpshttp://api-dev.bimplus.net/v2/users).

Add the user which you have created to the team using the Bimplus Membership Management Service(POST httpshttp://api-dev.bimplus.net/v2//members).

Verify whether the user has been added to the team by using the Bimplus Membership Management Service(GET httpshttp://api-dev.bimplus.net/v2//members). In the response tab, you can see the user(test@bimplus.net) who is part of the "best-company" team.

...

Deck of Cards

id	bimCreateProject

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects

URL: httpshttp://api-dev.bimplus.net/v2/<team>/projects

Example: httpshttp://api-dev.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	will be ignored	string (date)	Creation date of the project

Card

label	Description

Creates a new 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" : "Your Wonderful Model",
"shortDescr" : "The best building model in the world"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "name": "Your Wonderful Model",
    "shortDescr": "The best building model in the world",
    "thumbnail": null,
    "created": "2013-07-11T11:02:11.6567346Z",
    "changed": "2013-07-11T11:02:11.6567346Z",
    "disciplines": null,
    "id": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736"
}

...

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: httpshttp://api-dev.bimplus.net/v2/<team>/objects

Example: httpshttp://api-dev.bimplus.net/v2/bimplus/objects

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

label	Description

Creates a new object

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

{
    "parent": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
    "type": "TopologyDivision",
    "attributes": {
        "element": {
            "isparent": false,
            "elementtyp": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50",
            "logparentid": "b65b2534-55fe-4fe7-806a-da5bd1bccf75",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "isobjectvalid": true,
			"name": "First floor"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "7f76a497-e322-4b78-b820-1ce85ebc39db",
    "type": "TopologyDivision",
    "attributes": {
        "element": {
            "isparent": false,
            "elementtyp": "e003e080-f21b-4f8a-8c4c-4c9c5026cf50",
            "logparentid": "b65b2534-55fe-4fe7-806a-da5bd1bccf75",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "First floor",
            "isobjectvalid": true
        }
    }
}

...

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: httpshttp://api-dev.bimplus.net/v2/<team>/objects

Example: httpshttp://api-dev.bimplus.net/v2/bimplus/objects

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

label	Description

Creates a new object

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

{
    "parent" : "7f76a497-e322-4b78-b820-1ce85ebc39db",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
             "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":4278255360,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "921bc1f6-228a-4f79-937a-0251b60436b4",
    "type": "Wall",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "elementtyp": "10074eef-9418-4d64-9c6d-23932835a7f1",
            "logparentid": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "Brickwall",
            "isobjectvalid": true
        },
        "allplan": {
            "allplan_guid": "08b8195a-a2ad-11e2-9993-002215ea7d6b",
            "allplan_id": 2065507287,
            "allplan_text": "<PP>Wall",
            "dateofexport": "2013-05-01T09:32:13"
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[4450.01,115.01,0.01,3200.01,115.01,0.01,3200.01,0.01,0.01,4450.01,0.01,0.01,2315.01,0.01,0.01,2315.01,115.01,0.01,0.01,115.01,0.01,0.01,0.01,0.01,4450.01,115.01,2750.01,4450.01,0.01,2750.01,0.01,0.01,2750.01,0.01,115.01,2750.01,2315.01,115.01,2190.01,3200.01,115.01,2190.01,3200.01,0.01,2190.01,2315.01,0.01,2190.01],\"F\":[4,0,1,2,3,4,4,5,6,7,4,8,9,10,11,4,0,3,9,8,8,6,5,12,13,1,0,8,11,4,7,6,11,10,8,3,2,14,15,4,7,10,9,4,12,15,14,13,4,15,12,5,4,4,13,14,2,1]}"
        }
    }
}

...

Deck of Cards

id	bimGetObject1

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects

URL: httpshttp://api-dev.bimplus.net/v2/<team>/objects

Example: httpshttp://api-dev.bimplus.net/v2/bimplus/objects

JSON Structure:

Name	Mandatory / Optional	Type	Description
parent	optional	string (guid)	The id of the parent to which the object can be associated
type	mandatory	string	Element type of the object
attributes	optional	string	Attributes of the object
children	optional	Object	Children of the object

Card

label	Description

Creates a new object

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

{
    "parent" : "7f76a497-e322-4b78-b820-1ce85ebc39db",
    "type": "Column",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "matrix": "AAAAAAAA8D8AAAAAAAAAgAAAAAAAAACAINejcP1YsEAAAAAAAAAAgAAAAAAAAPA/AAAAAAAAAIAK16Nw/fy2QAAAAAAAAACAAAAAAAAAAIAAAAAAAADwPwAArkfheoS/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA8D8=",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18"
        },
        "general": {
            "name": "BrickColumn",
            "isobjectvalid": true
        },
        "quantity": {
            "width": 115,
			"volume" : 24
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[3843.438,-1048.958,-1565.0,3943.438,-1048.958,-1565.0,3943.438,-948.958,-1565.0,3843.438,-948.958,-1565.0,3843.438,-1048.958,635.0,3943.438,-1048.958,635.0,3943.438,-948.958,635.0,3843.438,-948.958,635.0],\"F\":[4,3,0,1,2,4,4,7,6,5,4,0,3,7,4,4,1,0,4,5,4,2,1,5,6,4,3,2,6,7]}"
        }
    }
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "de5a8d7e-701f-42ff-9731-f32fb1fb767d",
    "type": "Column",
    "attributes": {
        "element": {
            "isparent": false,
            "nr": 0,
            "elementtyp": "2e308afe-d078-4c20-b53c-76b2da66d848",
            "logparentid": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
            "divisionid": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "materialsurfaceid": "cdbd7fbc-0d02-4be5-adb3-04b7f0b2a638"
        },
        "general": {
            "name": "BrickColumn",
            "isobjectvalid": true
        },
        "geometry": {
            "mesh": "{\"C\":0,\"V\":[3843.438,-1048.958,-1565.0,3943.438,-1048.958,-1565.0,3943.438,-948.958,-1565.0,3843.438,-948.958,-1565.0,3843.438,-1048.958,635.0,3943.438,-1048.958,635.0,3943.438,-948.958,635.0,3843.438,-948.958,635.0],\"F\":[4,3,0,1,2,4,4,7,6,5,4,0,3,7,4,4,1,0,4,5,4,2,1,5,6,4,3,2,6,7]}"
        }
    }
}

...

For verifying whether the wall and the column is added to the project, we have to call GET httpshttp://api-dev.bimplus.net/v2/nemetschek/objects//topology. Please note that the API call GET httpshttp://api-dev.bimplus.net/v2/nemetschek/projects//topology will only give you its children (i.e topology) details. So, if your project is very big, you can first call GET httpshttp://api-dev.bimplus.net/v2/nemetschek/projects//topology and get the topology id(i.e 7f76a497-e322-4b78-b820-1ce85ebc39db in our example). Using the topology id we can get the object(wall, column in our case) details using the call GET httpshttp://api-dev.bimplus.net/v2/nemetschek/objects/7f76a497-e322-4b78-b820-1ce85ebc39db/topology.

Deck of Cards

id	bimGetProjectProp

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: objects/<object_id>/topology

URL: httpshttp://api-dev.bimplus.net/v2/<team>/objects/<object_id>/topology

Example: {nolink:httpshttp://api-dev.bimplus.net/v2/bimplus/objects/0bc9e4b7-d679-43d7-86e3-0ded12fc0736/topology

Card

label	Description

Get all the project properties of a project 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

{
    "parent": null,
    "name": "Your Wonderful Model",
    "type": "ID_Project",
    "children": [
        {
            "parent": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736",
            "name": "First floor",
            "type": "ID_TopologyDivision",
            "children": [
                {
                    "parent": "7f76a497-e322-4b78-b820-1ce85ebc39db",
                    "name": "Brickwall",
                    "type": "ID_ArchWall",
                    "children": [],
                    "id": "921bc1f6-228a-4f79-937a-0251b60436b4"
                },
                {
                    "parent": "7f76a497-e322-4b78-b820-1ce85ebc39db",
                    "name": "BrickColumn",
                    "type": "ID_ArchColumn",
                    "children": [],
                    "id": "de5a8d7e-701f-42ff-9731-f32fb1fb767d"
                }
            ],
            "id": "7f76a497-e322-4b78-b820-1ce85ebc39db"
        }
    ],
    "id": "0bc9e4b7-d679-43d7-86e3-0ded12fc0736"
}

...

Gliffy Diagram

size	L
name	US_Project_List

This API call(GET httpshttp://api-dev.bimplus.net/v2//projects) should retrieve the list of projects available to the team. In this call, only a few properties of the projects will be visible.

Using the project id got from the previous call, the full property list can be accessed using this API call(GET httpshttp://api-dev.bimplus.net/v2//projects/)

...

Thumbnail can be added to a project by using the Bimplus Project Service(POST httpshttp://api-dev.bimplus.net/v2//projects//thumbnail). There is also a service available for downloading the thumbnail.

...

Deck of Cards

id	bimUpdateProject

Card

label	HTTP Method

PUT

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: httpshttp://api-dev.bimplus.net/v2/<team>/projects/<project_id>

Example: httpshttp://api-dev.bimplus.net/v2/bimplus/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e

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

label	Description

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

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

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

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

...

Deck of Cards

id	bimUpdateProjProp

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: projects/<project_id>

URL: httpshttp://api-dev.bimplus.net/v2/<team>/projects/<project_id>

Example: httpshttp://api-dev.bimplus.net/v2/bimplus/projects/586b02be-43b8-4e27-b698-e067e85e38e2

Card

label	Description

Get all the project properties of a project 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

{
    "name": "Your Awesome Building",
    "shortDescr": "The example project",
    "thumbnail": "/nemetschek/projects/0d2ce2cc-3588-45d6-a59a-f6b89ebed34e/thumbnail/download",
    "created": "0001-01-01T00:00:00",
    "changed": "0001-01-01T00:00:00",
    "disciplines": [
        {
            "id": "0f106af0-a919-44c5-b211-15bd5ef620b6",
            "name": "ID_BuildingModel",
            "divisionId": "ac21b9a1-8853-4658-9fbf-0cf62340bd18",
            "divisionName": null,
            "revisions": []
        }
    ],
    "properties": {
        "mainfloorarea": "456m²",
        "architect": {
            "name": "NemetschekTech.GmbH",
            "street": "Konrad-Zuse-Platz1",
            "phone1": "089/12793-1115",
            "phone2": "0171/71384483",
            "email": "MyName@Nemetschek.com",
            "zip": "81829",
            "city": "Munich"
        },
        "customer": {
            "name": "Bimplus customer",
            "phone1": "001-201-1279345",
            "email": "MyName@Nemetschek.com",
            "zip": "08201",
            "city": "New Jersy"
        }
    },
    "id": "0d2ce2cc-3588-45d6-a59a-f6b89ebed34e"
}

...

mesh: It is the default geometry type. It is an uncompressed mesh format where the geometry object will be compressed on the server before storing it into the database. Please use this API call(GET httpshttp://api-dev.bimplus.net/v2//objects/) for getting the mesh information of an object.

...

meshblob: It is a compressed mesh format intended to be used in the desktop CAD applications. Internal CAD format of the geometry will be converted into a Bimplus compressed mesh format with the help of a DLL in order to minimize the JSON object. Please use this API call(GET httpshttp://api-dev.bimplus.net/v2//objects//geometries/meshblob) for getting the meshblob information of an object.

...

threejs: It is a format which is optimized for viewing on mobile devices or in browsers where the native model is filtered and tessellated in order to deliver minimal JSON size and maximal navigation speed (FPS). This model has ThreeJS JSON v 3.1 format and can be directly parsed by the client.Please use this API call(GET httpshttp://api-dev.bimplus.net/v2//objects//geometries/threejs) for getting the threejs information of an object.

...

The list of element types can be accessed through this API call(GET httpshttp://api-dev.bimplus.net/v2//element-types)

The list of layers can be accessed through this API call(GET httpshttp://api-dev.bimplus.net/v2//element-types/disciplines)

...

Please use this API call (GET httpshttp://api-dev.bimplus.net/v2/<team>/objects/<object_id>/disciplines/<discipline_id>/geometries/threejs) to get the object tree with selected property list whose geometry type is "ThreeJS" filtered by layer

Please use this API call (GET httpshttp://api-dev.bimplus.net/v2/<team>/objects/<object_id>/disciplines/<discipline_id>/geometries/meshblob) to get the object tree whose geometry type is "compressed geometry mesh (meshblob)" filtered by layer

...

A Pin can be created by using the Bimplus Issue Service (POST httpshttp://api-dev.bimplus.net/v2//issues//pins)

...

Please use the Bimplus Project Service (POST httpshttp://api-dev.bimplus.net/v2//projects//attachments) for adding an attachment to the project.

Verify whether the picture has been attached to the project using the Bimplus Project Service (GET httpshttp://api-dev.bimplus.net/v2//projects//attachments)

Please use the Bimplus Object Service (POST httpshttp://api-dev.bimplus.net/v2//objects/attachments) for adding an attachment to the object.

Verify whether the picture has been attached to the object using the Bimplus Object Service (GET httpshttp://api-dev.bimplus.net/v2//objects//attachments)

...

Anchor

	storyTeamList
	storyTeamList

...

Please use the Bimplus Team Management Service (GET httpshttp://api-dev.bimplus.net/v2/teams) to get the team list in which you are member of.

After getting the team list, use the Bimplus Membership Management Service (DELETE httpshttp://api-dev.bimplus.net/v2//members/) to delete yourself from some of the teams that you don't want to be part of.

...

Deck of Cards

id	bimAuthenticateToken

Card

label	HTTP Method

POST

Card

label	URL / Resource / JSON Structure

Resource: authorize

URL: httpshttp://api-dev.bimplus.net/v2/authorize

JSON Structure:

Name	Mandatory / Optional	Type	Description
user_id	mandatory	string	The email address of the user
password	mandatory	string	The user's password
client_id	optional	string	The identifier of the used client
application_id	optional	string	The id of the application

Card

label	Description

Authenticate by requesting and receiving a token.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

Card

default	true
label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
access_token: "e3271e89d8ea474c82745039bc2bed0d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

...

Deck of Cards

id	bimAuthenticateToken

Card

label	HTTP Method

POST

Card

label	URL / Resource / JSON Structure

Resource: authorize

URL: httpshttp://api-dev.bimplus.net/v2/authorize

JSON Structure:

Name	Mandatory / Optional	Type	Description
user_id	mandatory	string	The email address of the user
password	mandatory	string	The user's password
client_id	optional	string	The identifier of the used client
application_id	optional	string	The id of the application

Card

label	Description

Authenticate by requesting and receiving a token.

Card

default	true
label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Content-Type: application/json

Code Block

borderColor	Red
title	JSON
lang	xml

{
 "user_id" : "test@bimplus.net",
 "password" : "test",
 "client_id" : "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

{
access_token: "c33fa174169e46999fe82fb07fc53e3d"
expires_in: 2591999
client_id: "9fd0bb9d-570b-4719-bfae-93e2f879c19a"
token_type: "BimPlus"
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 346

New Version 347

Key