Versions Compared

Key

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

...

Create a new norm
Deck of Cards
idbimCreateMessagebimCreateNorm


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: norms

URLhttps://api-stage.bimplus.net/v2/ norms

Examplehttps://api-stage.bimplus.net/v2/norms

JSON Structure

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring(guid)The id of the norm. Will be taken from request url.
namemandatorystringNorm name
descriptionoptionalstringNorm description



Card
labelHTTP Method
 POST


Card
labelDescription

Create a new norm.


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json


Code Block
borderColorRed
langxml
titleJSON
{
  "name":"DIN 1046",
  "description":"DIN 1046"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
titleJSON
{
  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"DIN 1046",
  "description":"DIN 1046"
}



...

Get the norm list
Deck of Cards
idbimGetCurrentMessageListbimGetNormList


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: /norms 

URLhttps://api-stage.bimplus.net/v2/ norms

Examplehttps://api-stage.bimplus.net/v2/norms


Card
labelHTTP Method
 GET


Card
labelDescription
 Gets the norm list


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
[{
    "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94",
    "name":"DIN 1045",
    "description":"DIN 1045"
  },
  {
    "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
    "name":"DIN 17100",
    "description":"DIN 17100"
  }
]



...

Get the norm details
Deck of Cards
idbimGetMessagebimGetNorm


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: norms

URLhttps://api-stage.bimplus.net/v2/ norms/<norm_id>

Examplehttps://api-stage.bimplus.net/v2/norms/6de06146-125f-c7eb-95cc-0c07d85c4d94


Card
labelHTTP Method
 GET


Card
labelDescription
 Get information about a specified norm


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
  "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94",
  "name":"DIN 1045",
  "description":"DIN 1045"
}



...

Delete the specified norm
Deck of Cards
idbimDeleteMessagebimDeleteNorm


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: norms

URLhttps://api-stage.bimplus.net/v2/ norms/<norm_id>

Examplehttps://api-stage.bimplus.net/v2/norms/6de06146-125f-c7eb-95cc-0c07d85c4d94


Card
labelHTTP Method
 DELETE


Card
labelDescription

Delete the specified norm


Card
labelRequest


Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



...