Versions Compared

Key

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

...

If the Browser based REST clients does not select the Content-Type as "application/json", then please mention the content type in the header(Content-Type: application/json)

Composition Setup

{deck

...

idbimGetProjectList
Card
labelImplementation Status

Image Removed Service available !

Card
labelHTTP Method

POST

...

labelURL / Resource / Parameters

Resource: authorize 

...

:id=bimRequestToken}
{card:label=Implementation Status}
!check.gif|border=1! Service available \!
{card}
{card:label=HTTP Method}
POST
{card}
{card:label=URL / Resource / Parameters}
*Resource*: authorize 

*URL*: {nolink:https://api.bimplus.net/v2/}authorize

...

Card
defaulttrue
labelDescription

Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.

...

labelRequest

...

borderColorGreen
titleHeaders

...


{card}{card:label=Description}Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.

{card}{card:label=Request|default=true}
{code:title=Headers|borderColor=Green}
Content-Type: application/json

...

borderColorRed
titleJSON


{code}
\\
{code:title=JSON|borderColor=Red}{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}

...

labelResponse

...

borderColorGreen
titleStatus

{code}
{card}
{card:label=Response}
{code:title=Status|borderColor=Green}
Status: 200 OK

...

borderColorRed
titleJSON


{code}
\\
{code:title=JSON|borderColor=Red}{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"

...

}{code}
{card}
{deck}

h3. 2. Receive the

...

The token is received in the request

...

 authentication token 

The token is received in the request
{deck:id=bimReceiveToken}
\\
{card:label=Implementation Status}
!check.gif|border=1! Service available \!
{card}
\\
{card:label=HTTP Method}
POST
{card}
\\
{card:label=URL / Resource / Parameters}
*Resource*: authorize 

*URL*: {nolink:https://api.bimplus.net/v2/}authorize
{card}\\ {card:label=Description}Authenticates a user and returns a token which can be used for further API calls for accessing the desired resources.
{card}\\ {card:label=Request}
\\
{code:title=Headers|borderColor=Green}
Content-Type: application/json
{code}
\\
{code:title=JSON|borderColor=Red}{
 "user_id" : "test@bimplus.net",
 "password" : "test"
}{code}
\\
{card}
\\
{card:label=Response|default=true}
\\
{code:title=Status|borderColor=Green}
Status: 200 OK
{code}
\\
{code:title=JSON|borderColor=Red}{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"
}{code}
\\
{card}
\\
{deck}
{code}{
access_token: "c939ebf5b96646528e0022a35f7a2e67"
expires_in: 2591999
token_type: "BimPlus"

...

}{code}



h3. 3. Request the desired resource

...



Using the authentication token, the necessary resource can be accessed and the desired action can be performed on that resource using the BimPlus REST API.

Example:

{color:#000000}{*}Get Project List{*}{color}

Example:

...


Deck of Cards
idbimGetProjectList
Card
labelImplementation Status

Image Added Service available !

Card
labelHTTP Method

GET


Card
labelURL / Resource / Parameters

Resource: projects 

URLhttps://api.bimplus.net/v2/<company>/projects

Examplehttps://api.bimplus.net/v2/bimplus/projects

...



Card
defaulttrue
labelDescription

Get available project list with main properties.


Card
labelRequest


Code Block
borderColorGreen
titleHeaders

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



Card
labelResponse


Code Block
borderColorGreen
titleStatus

Status: 200 OK


Code Block
borderColorRed
titleJSON
[3

JSON Response:

Code Block
[4
]
0:  {
id: "c8c8e6f2-4495-484c-929d-0049f1f9d4ff"
name: 
null
"!!!!!_VORTEILSHAUS V40 SD45 Traufeingang"
}-
1:  {
id: "
f404ee03
2d703abe-
2e04
b4f9-
4d81
407c-
873e
af53-
13d672b02b7d
a39c5b7ba872"
name:
null
 "__5 999 Parklife Salzburg Lehen"
}-
2:  {
id: "
1dc48a10
c480cc54-
f283
aec4-
497a
4bef-
83de
8d35-
e5f1b56c4a41
93bb090e1aba"
name: 
null }- 3: { id: "586b02be-43b8-4e27-b698-e067e85e38e2" name: "!!!!!_VORTEILSHAUS V40 SD45 Traufeingang
"0811-Wohnhaus Kraus - Carport1"
}


Get Project Properties

Deck of Cards
idbimGetProjectProp


Card
labelImplementation Status

Image Added Service available !


Card
labelHTTP Method

GET


Card
labelURL / Resource / Parameters

Resource: projects/<project_id>

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

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


Card
defaulttrue
labelDescription

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


Card
labelRequest


Code Block
borderColorGreen
titleHeaders

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



Card
labelResponse


Code Block
borderColorGreen
titleStatus

Status: 200 OK


Code Block
borderColorRed
titleJSON
{
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"
}



Tools 

Anchor
Test
Test

Plugins for doing REST based calls (REST Client)

...