Versions Compared

Key

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

...

Catalog Service

...


Catalog Service

...

Anchor
createNorm
createNorm

Create a new norm
Deck of Cards
idbimCreateNorm

...

Create a new norm
Deck of Cards
idbimCreateMessage


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



...

Anchor
getCountryList
getCountryList

Get the

...

country list
Deck of Cards
idbimGetCountryList


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: countries

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

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


Card
labelHTTP Method
 GET


Card
labelDescription
 Gets the country 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":"2909b0d8-c6de-425d-2303-256336ada04f",
    "name":"Germany",
    "description":"Germany"
  },
  {
    "id":"b7e10710-94f8-bfdf-72a0-eaa80f3bc57e",
    "name":"Italy",
    "description":"Italy"
  }
]



Anchor
getCountry
getCountry

Get the

...

country details
Deck of Cards
idbimGetCountry


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: countries

URLhttps://api-stage.bimplus.net/v2/ countries/<country_id>

Examplehttps://api-stage.bimplus.net/v2/countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385


Card
labelHTTP Method
 GET


Card
labelDescription
 Get information about a specified country


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":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"Austria",
  "description":"Austria"
}



Anchor
deleteCountry
deleteCountry

Delete the specified

...

country
Deck of Cards
idbimDeleteCountry


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: countries

URLhttps://api-stage.bimplus.net/v2/ countries/<country_id>

Examplehttps://api-stage.bimplus.net/v2/countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385


Card
labelHTTP Method
 DELETE


Card
labelDescription

Delete the specified country


Card
labelRequest


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



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK



Anchor

...

getCatalogTypesList

...

getCatalogTypesList

...

Get a list of catalog types
Deck of Cards
idbimBrowserMessageReadbimGetCatalogTypesList


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id>/markasreadbrowser catalogs/types

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser  catalogs/types

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser catalogs/types

JSON Structure

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring(guid)The id of the catalog type.
namemandatorystringCatalog type name
descriptionoptionalstringCatalog type description



Card
labelHTTP Method
 POST GET


Card
labelDescription
 Mark  Get a message or group of messages by given posting as read by browser.list of catalog types


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

...

borderColor

...

Red
langxml
titleJSON
[{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  ...
]



Anchor
getCatalogType
getCatalogType

Get the catalog type details
Mark a browser message as "read"
Deck of Cards
idbimBrowserMessageReadbimGetCatalogType


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource:

messages/<message_id>/markasreadbrowser 

catalogs/types

URLhttps://api-stage.bimplus.net/v2/messages catalogs/types/<message<catalogType_id>/markasreadbrowser 

Examplehttps://api-stage.bimplus.net/v2/messagescatalogs/<message_id>/markasreadbrowser types/992bdb90-e093-4e6d-82cd-d8395ec14496


Card
labelHTTP Method
 POST GET


Card
labelDescription
 Mark a message or group of messages by given posting as read by browser. 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

...

borderColor

...

Red
langxml
titleJSON
{
  "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
  "name":"Material",
  "description":"Material"
}



Anchor
createCatalogItem
createCatalogItem

Create a new catalog item
Deck of Cards
idbimCreateCatalogItem


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: catalogitems
Mark a browser message as "unread"
Deck of Cards
idbimBrowserMessageUnead
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id>/markasunreadbrowser 

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>/markasunreadbrowser  catalogitems

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>/markasunreadbrowser 

Card
labelHTTP Method
 POST
Card
labelDescription

Mark a message or group of messages by given posting as unread by browser.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...

catalogitems

JSON Structure

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring(guid)The id of the catalog item
namemandatorystringCatalog item name
descriptionoptionalstringCatalog item description
catalogIdmandatorystringCatalog id. Newly created catalog item belongs to this catalog
propertiesoptionalobject(dictionary)Object which contains pairs of all parameter values for catalog item.
Value in pair represent attribute value of the attribute with Id specified as key in pair.
diagramoptionalobjectObject which includes data for custom table (sigma-epsilon diagram )



Card
labelHTTP Method
 POST


Card
labelDescription

Create a new catalog item to the specified catalog.


Card
labelRequest


Code Block
borderColorGreen
lang

...

Mark an email message as "unread"
Deck of Cards
idbimEmailMessageUnread
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id>/markasunreademail 

URLhttps://api-stage.bimplus.net/v2/messages/<message_id>/markasunreademail

Examplehttps://api-stage.bimplus.net/v2/messages/<message_id>/markasunreademail

Card
labelHTTP Method
 POST
Card
labelDescription
 Mark an email message as unread.
Response
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
label


Code Block
borderColorGreenRed
langxml
titleStatus
Status: 200 OK

...

JSON
{
    "catalogId": "ae2122c0-f667-f242-40ee-3e57161e433a",
    "properties": {
        "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4": "1e-05",
        "029ca99d-d590-3f36-60ad-c2f8538b6bf4": "No",
        "4fd9b113-4e9f-22e5-62ab-eb099fb0836f": "Bi-linear stress-strain diagram",
        "bb88f378-a30c-de7c-a70b-6522c917bd3f": "slow",
        "71164ead-883b-a610-61d0-c32e8caa5cfa": "Quartzite",

...

Filter the messages (eg: Get all the unread messages from a particular user)
Deck of Cards
idbimGetMessageList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26....

URLhttps://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

Examplehttps://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

where "%26" is the escape character for "&"

Card
labelHTTP Method
 GET
Card
labelDescription
 Get information about a specified message
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": "44ad058b-1f76-4343-bafa-031eb462215c"11f347c7-4ebf-fe22-5285-1edeb916c0de": 32300000000,
        "receiverca5d193d-c7c8-be57-a244-e7d751a67824": {13458300000,
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed""ceb34ade-8a26-f9a5-b3ea-f247486a1778": 2500,
            "email"52941ec9-f125-d765-aaca-07c7a3e86997": "customer@bimplus.net"0.2,
        }"efd8c210-8d8e-21e6-987f-8924159f961f": 0.2,
        "senderc905659b-74c8-dd27-7c61-e9722abbf9a3": {600,
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed""9813d85d-cd87-1db0-a4ce-08a94375ecae": 45,
            "email"3f2e236f-5708-2eb7-8715-e2f52a6af34b": "testuser1@bimplus.net"
28000000,
         }"2a30c3bb-3584-5ea9-599e-497f7a984d1d": 2800000,
        "source9b6d72a6-b230-78da-6ed3-79630fc263e7": "IssueService"1900000,
        "topic9b6e9387-a6d4-af90-bfd5-196d47e67f64": "ISSUE_DELETED"0.002,
        "severityd91470f2-8a8d-f7d2-de56-e61747fbbb27": "Info"0.0035,
        "returnCode": "ISSUE_DELETED"84bbcf5f-fc3f-19fe-47e3-0e9edbb6961e": 0.00175,
        "timestampae3aa29d-e553-afe6-5a71-82363dab1636": "2014-05-09T09:54:17"0.0035,
        "unreadBrowserNotification2f6bcd7f-f3b3-b346-d857-5cd0ca17e31f": true36000000,
        "unreadEmail0e588097-5259-fc18-9e74-122f73bbb4f8": false0,
        "correlationIdd3535e56-710b-a585-3f79-c984760625b2": null
    }0,
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762""9b7d1f57-0872-b143-4d5f-19630077c058": 0.032,
        "receivera27d570d-b739-6acf-50b1-12c73ba1ce36": {2,
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed""aa309ea3-de6d-1274-fc6b-380a14e91ef2": 0.9,
            "email": "customer@bimplus.net"
        }"5b92e65f-9874-4187-c561-064fb845507d": 0,
        "sender": {2cd643c8-f198-aad7-8f99-5f35052b3e7c": 3600000
    },
    "diagram": {
        "idcolumns": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
[
            { "emailname": "testuser1@bimplus.netsig"
, "type": "Double" },
     },
       { "sourcename": "IssueServiceeps",
        "topic"type": "ISSUE_UPDATEDDouble" },
        "severity": "Info"],
        "returnCoderows": "ISSUE_UPDATED",
 [
       "timestamp": "2014-04-08T08:54:41",
       { "unreadBrowserNotificationitems": false,
   [ -4.69565e+08, -0.05 ] },
     "unreadEmail": false,
      {  "correlationIditems": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
    [ -4.6751e+08, -0.045 ] },
    {
        { "iditems": [ "ffd50096-fb82-4029-8d49-06a04e31f02a",
-4.34783e+08, -0.00217391 ] },
            { "receiveritems": {[ 0, 0 ] }
        ]
    },
    "id": "71e0ac3b3ea0079e-fa497cd9-e5408ea0-ac2f1163-8caff3dd72ed70cef77e7eff",
            "email"name": "customer@bimplus.net"C28/35",
    "description":    },"(Dutch NEN-EN NA)"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
titleJSON
{
    "catalogId": "ae2122c0-f667-f242-40ee-3e57161e433a",
    "senderproperties": {
            "id"7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed1e-05",
            "email"029ca99d-d590-3f36-60ad-c2f8538b6bf4": "testuser2@bimplus.net"
        }No",
        "source4fd9b113-4e9f-22e5-62ab-eb099fb0836f": "IssueServiceBi-linear stress-strain diagram",
        "topicbb88f378-a30c-de7c-a70b-6522c917bd3f": "ISSUE_DELETEDslow",
        "severity71164ead-883b-a610-61d0-c32e8caa5cfa": "InfoQuartzite",
        "returnCode11f347c7-4ebf-fe22-5285-1edeb916c0de": "ISSUE_DELETED"32300000000,
        "timestamp": "2014-05-09T09:54:27"ca5d193d-c7c8-be57-a244-e7d751a67824": 13458300000,
        "ceb34ade-8a26-f9a5-b3ea-f247486a1778": 2500,
        "unreadBrowserNotification52941ec9-f125-d765-aaca-07c7a3e86997": false0.2,
        "unreadEmailefd8c210-8d8e-21e6-987f-8924159f961f": true0.2,
        "correlationIdc905659b-74c8-dd27-7c61-e9722abbf9a3": null
    }
]

...

Get all messages sent by given user to all single users
Deck of Cards
idbimGetAllMessagesSentByUserToUsers
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: user/<user_id>/messages/sent

URLhttps://api-stage.bimplus.net/v2/user/<user_id>/messages/sent

Examplehttps://api-stage.bimplus.net/v2/user/1110ac3b-fa49-e540-ac2f-8caff3dd72ed/messages/sent

Card
labelHTTP Method
 GET
Card
labelDescription

Gets the list of all messages sent from user (user_id) to all single users

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":"481713d6-7dab-410c-8c8a-d65ff1d4a766",
    "sender":{
      "id":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed"600,
        "9813d85d-cd87-1db0-a4ce-08a94375ecae": 45,
        "3f2e236f-5708-2eb7-8715-e2f52a6af34b": 28000000,
        "2a30c3bb-3584-5ea9-599e-497f7a984d1d": 2800000,
        "9b6d72a6-b230-78da-6ed3-79630fc263e7": 1900000,
        "9b6e9387-a6d4-af90-bfd5-196d47e67f64": 0.002,
        "d91470f2-8a8d-f7d2-de56-e61747fbbb27": 0.0035,
        "84bbcf5f-fc3f-19fe-47e3-0e9edbb6961e": 0.00175,
        "ae3aa29d-e553-afe6-5a71-82363dab1636": 0.0035,
      "email":"customer1@bimplus.net"
    }  "2f6bcd7f-f3b3-b346-d857-5cd0ca17e31f": 36000000,
    "receiver":{
      "id":"1e2223b-fa49-e540-ac2f-8caff3dd72ed""0e588097-5259-fc18-9e74-122f73bbb4f8": 0,
      "email":"customer2@bimplus.net"  "d3535e56-710b-a585-3f79-c984760625b2": 0,
    },
    "source":"ServiceName2"9b7d1f57-0872-b143-4d5f-19630077c058": 0.032,
    "topic":"SKETCHUP_JOB",
    "severitya27d570d-b739-6acf-50b1-12c73ba1ce36":"Info" 2,
    "returncode":"FILE_TOO_BIG",
    "timestamp":"2013-11-18T14:55:22"aa309ea3-de6d-1274-fc6b-380a14e91ef2": 0.9,
    "unreadBrowserNotification":false,
    "unreadEmail":false5b92e65f-9874-4187-c561-064fb845507d": 0,
    "additionaldata":null,
    "correlationid2cd643c8-f198-aad7-8f99-5f35052b3e7c":null
  },3600000
  {
    "id":"93c29c5d-1391-4ae8-8876-ef9815e60f7d"},
    "senderdiagram": {
        "idcolumns":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed", [
      "email":"customer1@bimplus.net"
    },
   { "receivername":{
      "sig", "idtype":"1e2223b-fa49-e540-ac2f-8caff3dd72ed" "Double" },
      "email":"customer2@bimplus.net"
    },
  {  "sourcename": "ServiceNameeps",
    "topictype": "IFC_JOBDouble" },
    "severity":"Info"    ],
        "returncoderows":"OK",
 [
      "timestamp":"2013-11-18T14:30:53"      { "items": [ -4.69565e+08, -0.05 ] },
    "unreadBrowserNotification":true        { "items": [ -4.6751e+08, -0.045 ] },
    "unreadEmail":false,
     "additionaldata":null,
   { "correlationiditems":null
  }
]

...

Get all messages sent by given user to all groups

...

idbimGetAllMessagesSentByUserToGroups
[ -4.34783e+08, -0.00217391 ] },
            { "items": [ 0, 0 ] }
        ]
    },
    "id": "3ea0079e-7cd9-8ea0-1163-70cef77e7eff",
    "name": "C28/35",
    "description": "(Dutch NEN-EN NA)"
}



Anchor
getCatalogItem
getCatalogItem

Get the catalog item details
Deck of Cards
idbimGetCatalogItem


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: catalogitems

URLhttps://api-stage.bimplus.net/v2/ catalogitems/<catalogitem_id>

Examplehttps://api-stage.bimplus.net/v2/catalogitems/f15e402a-d29d-023c-745d-2b2f41c58483


Optional query parameters: Used to refine and reduce the set of returned catalog items

Name

Type

Default value

Description

unitstring metric

When query parameter "unit=imperial" is defined, the API will return free-attribute of catalog item with imperial unit.
e.g. https://api-stage.bimplus.net/v2/catalogitems/d3a532ce-145a-5a91-4bba-a445630b93ca/?unit=imperial

Query unit can be only ?unit=metric or ?unit=imperial.

filterstring

When filter "name=I200" is defined the API will return only of catalog item which Name contains requested sub-string, e.g. https://api-stage.bimplus.net/v2/catalogitems?filter=name=I1

if filter is "name=I1" will be returned all catalog items which Name contains substring "I1".
Like I100 I150, etc.



Card
labelHTTP Method
 GET


Card
labelDescription
 Get information about a specified catalog item


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
{
  "catalogId":"2d116846-5f7c-a780-3a82-6dd8150989df",
  "properties":{
    "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4":"1.2e-05",
    "029ca99d-d590-3f36-60ad-c2f8538b6bf4":"No",
    "9df611ca-c547-e0ab-4595-8a017a383592":210000000000,
    "ca5d193d-c7c8-be57-a244-e7d751a67824":80769200000,
    "ceb34ade-8a26-f9a5-b3ea-f247486a1778":7850,
    "52941ec9-f125-d765-aaca-07c7a3e86997":0.3,
    "efd8c210-8d8e-21e6-987f-8924159f961f":0.15,
    "c905659b-74c8-dd27-7c61-e9722abbf9a3":600,
    "9813d85d-cd87-1db0-a4ce-08a94375ecae":45,
    "633a90c2-a927-faf3-22d4-7a17e4f2b81a":355000000,
    "d450c196-451f-6811-0b47-53c5b81f2cc9":470000000
  },
  "id":"f15e402a-d29d-023c-745d-2b2f41c58483",
  "name":"S 998",
  "description":"test catalog item "
}



Anchor
createCatalog
createCatalog

Create a new catalog
Deck of Cards
idbimCreateCatalog


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: catalogs

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

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

JSON Structure

Name

Mandatory / Optional

Type

Description

idwill be ignoredstring(guid)The id of the catalog
namemandatorystringCatalog name
descriptionoptionalstringCatalog description
catalogtypemandatoryobjectCatalog type object. Mandatory is only Id of the catalog type object.
See response of Get a list of catalog types
normsoptionalJSON arrayArray of norm objects, see json response part of Get the norm list .
Mandatory is only Id of the norm object
countriesoptionalJSON arrayArray of country objects, see json response part of Get the country list .
Mandatory is only Id of the country object



Card
labelHTTP Method
 POST


Card
labelDescription

Create a new catalog.


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
  "name":"Timber",
  "description":"Timber",
  "catalogtype":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496"
  }
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 201 Created


Code Block
titleJSON
{
  "norms":[],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"10e3f185-234e-9686-5fea-73075149abd2",
  "name":"Timber",
  "description":"Timber"
}



Anchor
getCatalogList
getCatalogList

Get the catalog list
Deck of Cards
idbimGetCatalogList


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: catalogs

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

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


Card
labelHTTP Method
 GET


Card
labelDescription
 Gets the catalog 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
[{
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"2d116846-5f7c-a780-3a82-6dd8150989df",
    "name":"Steel",
    "description":"Steel"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
    "name":"Concrete",
    "description":"Concrete"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"2e5f209b-98e4-f731-9f54-f9ade4a87587",
    "name":"Aluminium",
    "description":"Aluminium"
  }
]



Anchor
getCatalog
getCatalog

Get the catalog details
Deck of Cards
idbimGetCatalog


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: catalogs

URLhttps://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Examplehttps://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a


Card
labelHTTP Method
 GET


Card
labelDescription
 Get information about a specified catalog


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
{
  "norms":[{
      "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
      "name":"EC"
    }
  ],
  "countries":[{
      "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
      "name":"Standard EN"
    }
  ],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete",
  "description":"Concrete"
}



Anchor
putCatalog
putCatalog

Update the specified catalog
Deck of Cards
idbimPutCatalog


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: catalogs

URLhttps://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Examplehttps://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a


Card
labelHTTP Method
 PUT


Card
labelDescription
 Update the specified catalog.


Card
labelRequest


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


Code Block
borderColorRed
langxml
titleJSON
{
  "norms":[{
      "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
      "name":"European",
      "description":"European"
    }
  ],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "name":"Concrete X",
  "description":"Concrete"
}



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
  "norms":[{
      "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
      "name":"European",
      "description":"European"
    }
  ],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete X",
  "description":"Concrete"
}



Anchor
getCatalogItemList
getCatalogItemList

Get the catalog item list from the specified catalog
Deck of Cards
idbimGetCatalogItemList


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: catalogs/<catalog_id>/items

URLhttps://api-stage.bimplus.net/v2/ catalogs/<catalog_id>/items

Examplehttps://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items

Optional query parameters: Used to refine and reduce the set of returned catalog items

Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: user/<user_id>/messages/groupsent

URLhttps://api-stage.bimplus.net/v2/user/<user_id>/messages/groupsent

Examplehttps://api-stage.bimplus.net/v2/user/1110ac3b-fa49-e540-ac2f-8caff3dd72ed/messages/groupsent

Card
labelHTTP Method
 GET
Card
labelDescription

Gets the list of all messages sent from user (user_id) to all users groups

...

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

...

labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
[{
    "id":"481713d6-7dab-410c-8c8a-d65ff1d4a766",
    "sender":{
      "id":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
      "email":"customer1@bimplus.net"
    },
    "group":{
      "id":"1e2223b-fa49-e540-ac2f-8caff3dd72ed",
      "name":"Users from Italy",
      "description":"Group of users from Italy"
    },
    "source":"DashboardAnnouncement",
    "topic":"DASHBOARD",
    "severity":"Info",
    "returncode":"FILE_TOO_BIG",
    "timestamp":"2013-11-18T14:55:22",
    "unreadBrowserNotification":false,
    "unreadEmail":false,
    "additionalData":"{ Test message to group Italy}",
    "correlationid":null
  },
  {
    "id":"8757d4c6-477b-419e-b0e2-52cbb9e1b1a8",
    "sender":{
      "id":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
      "email":"customer1@bimplus.net"
    },
    "group":{
      "id":"594bbc5d-1949-4d74-84d3-B966a42c68A1",
      "name":"Users from France",
      "description":"Group of users from France"
    },
    "source":"DashboardNews",
    "topic":"DASHBOARD",
    "severity":"Info",
    "returncode":"OK",
    "timestamp":"2013-11-18T14:30:53",
    "unreadBrowserNotification":true,
    "unreadEmail":false,
    "additionalData":"{ Test message to group France}",
    "correlationid":null
  }
]

...

Get all messaging groups
Deck of Cards
idbimGetAllMessagingGroups
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups URL

Name

Type

Default value

Description

codestring

When query parameter "code=DIN 1045" is defined, the API will return from requested catalog only items which are related to code/norm DIN 1045.
Instead of code name can be used also codeId 6de06146-125f-c7eb-95cc-0c07d85c4d94. Query parameter 'code' can be interchanged with query parameter norm.
When are defined both query parameters - code and norm, only code is used in api call.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045

To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany

normstring

When query parameter "norm=DIN 1045" is defined, the API will return from requested catalog only items which are related to code/norm DIN 1045.
Instead of code name can be used also normId 6de06146-125f-c7eb-95cc-0c07d85c4d94. Query parameter 'norm' can be interchanged with query parameter code.
When are defined both query parameters - code and norm, only code is used in api call.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?norm=DIN 1045

To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany

nastring

When query parameter "na=Germany" is defined, the API will return from requested catalog only items which are related to country Germany.
Instead of country name can be used also country Id 2909b0d8-c6de-425d-2303-256336ada04f. Query parameter 'na' can be interchanged with query parameter 'country'.
When are defined both query parameters - 'na' and 'country', only 'na' parameter is used in api call.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?na=Germany

To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&na=Germany

countrystring

When query parameter "country=Germany" is defined, the API will return from requested catalog only items which are related to country Germany.
Instead of country name can be used also country Id 2909b0d8-c6de-425d-2303-256336ada04f. Query parameter 'country' can be interchanged with query parameter 'na'.
When are defined both query parameters - 'na' and 'country', only 'na' parameter is used in api call.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?country=Germany

To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter.

e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany

filterstring

When filter "name=S 998" is defined the API will return only catalog items which Name contains requested sub-string,
e.g. if filter is "name=S 998" will be returned all catalog items which Name contains substring "S 998".

e.g.

/systemgroupsExample

/catalogs/2d116846-5f7c-a780-3a82-6dd8150989df/items?filter=name=S 998

To get more precisely specified result set of catalog items, can be combined query parameter filter (by name) together with 'country' or 'code' query parameter.

e.g. https://api-stage.

bimplus.net/v2/systemgroups

bimplus.net/v2/catalogs/2d116846-5f7c-a780-3a82-6dd8150989df/items?filter=name=S 998&code=DIN 1045&country=Germany




Card
labelHTTP Method
 GET


Card
labelDescription
 Gets all existing messaging groups. Get all catalog items of the catalog


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


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
[{
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"754da75a-c96d-6d4f-01a9-33a178394ecb",
    "name":"GL 26h",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"27d2555d-2245-a84a-7950-a4898077261f",
    "name":"GL 30h",
    "description":"(EN 14080)"
  },
  
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
[{
    "systemGroupcatalogId":{
 "10e3f185-234e-9686-5fea-73075149abd2",
     "id":"9c3c8a6c02ce9b8b-67b5720c-406fa44c-a44cb115-0dca6eb3c031f45a0de7d965",
      "name":"UsersGL from Munich32c",
      "description":"Group of users from Munich area(EN 14080)"
  },
  },{
    "usersIdListcatalogId":["6ae9009810e3f185-5b01234e-41419686-8ef55fea-0079ae6c1c0473075149abd2",
      "9d32f46b-157f-dfee-a5d7-0162543dc304"id":"0e00c600-8004-6a03-8110-4d38c3dc40aa",
      "a33e89a2-b5fc-408a-b4ec-01fb593e2b1d"
    ]"name":"GL 24h",
    "description":"(EN 14080)"
  },
  {
    "systemGroupcatalogId":{"10e3f185-234e-9686-5fea-73075149abd2",
      "id":"242fab5afb3bfbb8-fce6aa6a-441364b3-900bb78e-5f5b6ca2a4148950ca107891",
      "name":"Users fromGL Paris28h",
      "description":"Group of users from Paris(EN 14080)"
  },
  },{
    "usersIdListcatalogId":["61c9c32510e3f185-52a2234e-21b59686-47b65fea-0a06e7152ff973075149abd2",
      "6be10633-5950-319f-eae0-12dec2c04219"id":"9be0c733-243d-2e1c-c79c-7be0a2b6c1a3",
      "2e798f29-4b71-15ee-90eb-18592bc18317"
    ]"name":"GL 32h",
    "description":"(EN 14080)"
  }
]



Anchor
getMessagingGroupDetailsdeleteCataloggetMessagingGroupDetails
deleteCatalog

...

Delete the specified catalog
Deck of Cards
idbimGetMessagingGroupDetailsbimDeleteCatalog


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

Examplehttps://api-stage.bimplus.net/v2/systemgroupscatalogs/242fab5aae2122c0-fce6f667-4413-900b-5f5b6ca2a414

Card
defaulttrue
labelURL / Resource / JSON Structure

Resource:

systemgroups/<messaginggroup_id>

catalogs

URLhttps://api-stage.bimplus.net/v2/systemgroups catalogs/<messaginggroup<catalog_id>

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of a specified messaging group. Description of returned json in Create a new messaging group.

f242-40ee-3e57161e433a


Card
labelResponseHTTP Method
code DELETEborderColor


GreenStatus: 200 OK
Card
label
langxml
titleStatus
Description

Delete the specified catalog


Card
labelRequest


Code Block
borderColorRedGreen
langxml
titleJSONHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
{
  "systemGroup":{
    "id":"242fab5a-fce6-4413-900b-5f5b6ca2a414",
    "name":"Bimplusdevelopers",
    "description":""
  },
  "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
    "6be10633-5950-319f-eae0-12dec2c04219",
    "3b638075-24cd-cb2b-5464-fa955d2bd1e0"
  ]
}