Page History

...

Get all messages sent by given user to all groups

Catalog Service

...

Catalog Service

...

Anchor

	createNorm
	createNorm

Create a new norm

Deck of Cards

id	bimCreateNorm

...

Create a new norm

Deck of Cards

id	bimCreateMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms

URL: https://api-stage.bimplus.net/v2/ norms

Example: https://api-stage.bimplus.net/v2/norms

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the norm. Will be taken from request url.
name	mandatory	string	Norm name
description	optional	string	Norm description

Card

label	HTTP Method

POST

Card

label	Description

Create a new norm.

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":"DIN 1046",
  "description":"DIN 1046"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

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

...

Get the norm list

Deck of Cards

id	bimGetCurrentMessageListbimGetNormList

Card

default	true
label	URL / Resource / JSON Structure

Resource: /norms

URL: https://api-stage.bimplus.net/v2/ norms

Example: https://api-stage.bimplus.net/v2/norms

Card

label	HTTP Method

GET

Card

label	Description

Gets the norm list

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

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

id	bimGetMessagebimGetNorm

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms

URL: https://api-stage.bimplus.net/v2/ norms/<message<norm_id>

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

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified norm

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

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

...

Delete the specified norm

Deck of Cards

id	bimDeleteMessagebimDeleteNorm

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms

URL: https://api-stage.bimplus.net/v2/ norms/<message<norm_id>

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified norm

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

Anchor

...

	createCountry

...

	createCountry

...

Create a new country

Deck of Cards

id	bimBrowserMessageReadbimCreateCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasreadbrowser countries

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser countries

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasreadbrowser countries

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the country. Will be taken from request url.
name	mandatory	string	Country name
description	optional	string	Country description

Card

label	HTTP Method

POST

Card

label	Description

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

Create a new country.

label

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

Response

Code Block

borderColor	GreenRed
lang	xml
title	Status

Status: 200 OK

...

JSON

{
  "name":"Austria",
  "description":"Austria"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"Austria",
  "description":"Austria"
}

Anchor

	getCountryList
	getCountryList

Get the country list

Deck of Cards

id	bimGetCountryList

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

...

Mark a browser message as "unread"

Deck of Cards

id	bimBrowserMessageUnead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasunreadbrowser

URL: https://api-stage.bimplus.net/v2/messages/<message_id>/markasunreadbrowser countries

Example: https://api-stage.bimplus.net/v2/messages/<message_id>/markasunreadbrowser countries

Card

label	HTTP Method

POST GET

Card

label	Description

Mark a message or group of messages by given posting as unread by browser. Gets the country list

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

...

Mark an email message as "unread"

Red
lang	xml
title	JSON

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

id	bimGetCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified country

Card

label	Request

Deck of Cards

id	bimEmailMessageUnread

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasunreademail

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

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

Card

label	HTTP Method

POST

Card

label	Description

Mark an email message as unread.

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	StatusHeaders

StatusAuthorization: 200BimPlus OK

...

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

{
  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"Austria",
  "description":"Austria"
}

Anchor

	deleteCountry
	deleteCountry

Delete the specified country

Deck of Cards

id	bimDeleteCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

...

Filter the messages (eg: Get all the unread messages from a particular user)

Deck of Cards

id	bimGetMessageList

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26....

URL: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService/ countries/<country_id>

Example: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueServicewhere "%26" is the escape character for "&"countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385

Card

label	HTTP Method

GET DELETE

Card

label	Description

Get information about a specified message

Delete the specified country

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

Anchor
getCatalogTypesList
getCatalogTypesList

Get a list of catalog types

Deck of Cards

id	bimGetCatalogTypesList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs/types

URL: https://api-stage.bimplus.net/v2/ catalogs/types

Example: https://api-stage.bimplus.net/v2/catalogs/types

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog type.
name	mandatory	string	Catalog type name
description	optional	string	Catalog type description

Card

label	HTTP Method

GET

Card

label	Description

Get a list of catalog types

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

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

Anchor

	getCatalogType
	getCatalogType

Get the catalog type details

Deck of Cards

id	bimGetCatalogType

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs/types

URL: https://api-stage.bimplus.net/v2/ catalogs/types/<catalogType_id>

Example: https://api-stage.bimplus.net/v2/catalogs/types/992bdb90-e093-4e6d-82cd-d8395ec14496

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified norm

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

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

Anchor

	createCatalogItem
	createCatalogItem

Create a new catalog item

Deck of Cards

id	bimCreateCatalogItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogitems

URL: https://api-stage.bimplus.net/v2/ catalogitems

Example: https://api-stage.bimplus.net/v2/catalogitems

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog item
name	mandatory	string	Catalog item name
description	optional	string	Catalog item description
catalogId	mandatory	string	Catalog id. Newly created catalog item belongs to this catalog
properties	optional	object(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.
diagram	optional	object	Object which includes data for custom table (sigma-epsilon diagram )

Card

label	HTTP Method

POST

Card

label	Description

Create a new catalog item to the specified catalog.

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

{
    "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",
        "11f347c7-4ebf-fe22-5285-1edeb916c0de": 32300000000,
        "ca5d193d-c7c8-be57-a244-e7d751a67824": 13458300000,
        "ceb34ade-8a26-f9a5-b3ea-f247486a1778": 2500,
        "52941ec9-f125-d765-aaca-07c7a3e86997": 0.2,
        "efd8c210-8d8e-21e6-987f-8924159f961f": 0.2,
        "c905659b-74c8-dd27-7c61-e9722abbf9a3": 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,
        "2f6bcd7f-f3b3-b346-d857-5cd0ca17e31f": 36000000,
        "0e588097-5259-fc18-9e74-122f73bbb4f8": 0,
        "d3535e56-710b-a585-3f79-c984760625b2": 0,
        "9b7d1f57-0872-b143-4d5f-19630077c058": 0.032,
        "a27d570d-b739-6acf-50b1-12c73ba1ce36": 2,
        "aa309ea3-de6d-1274-fc6b-380a14e91ef2": 0.9,
        "5b92e65f-9874-4187-c561-064fb845507d": 0,
        "2cd643c8-f198-aad7-8f99-5f35052b3e7c": 3600000
    },
    "diagram": {
        "columns": [
            { "name": "sig", "type": "Double" },
            { "name": "eps", "type": "Double" },
        ],
        "rows": [
            { "items": [ -4.69565e+08, -0.05 ] },
            { "items": [ -4.6751e+08, -0.045 ] },
            { "items": [ -4.34783e+08, -0.00217391 ] },
            { "items": [ 0, 0 ] }
        ]
    },
    "id": "3ea0079e-7cd9-8ea0-1163-70cef77e7eff",
    "name": "C28/35",
    "description": "(Dutch NEN-EN NA)"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	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",
        "11f347c7-4ebf-fe22-5285-1edeb916c0de": 32300000000,
        "ca5d193d-c7c8-be57-a244-e7d751a67824": 13458300000,
        "ceb34ade-8a26-f9a5-b3ea-f247486a1778": 2500,
        "52941ec9-f125-d765-aaca-07c7a3e86997": 0.2,
        "efd8c210-8d8e-21e6-987f-8924159f961f": 0.2,
        "c905659b-74c8-dd27-7c61-e9722abbf9a3": 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,
        "2f6bcd7f-f3b3-b346-d857-5cd0ca17e31f": 36000000,
        "0e588097-5259-fc18-9e74-122f73bbb4f8": 0,
        "d3535e56-710b-a585-3f79-c984760625b2": 0,
        "9b7d1f57-0872-b143-4d5f-19630077c058": 0.032,
        "a27d570d-b739-6acf-50b1-12c73ba1ce36": 2,
        "aa309ea3-de6d-1274-fc6b-380a14e91ef2": 0.9,
        "5b92e65f-9874-4187-c561-064fb845507d": 0,
        "2cd643c8-f198-aad7-8f99-5f35052b3e7c": 3600000
    },
    "diagram": {
        "columns": [
            { "name": "sig", "type": "Double" },
            { "name": "eps", "type": "Double" },
        ],
        "rows": [
            { "items": [ -4.69565e+08, -0.05 ] },
            { "items": [ -4.6751e+08, -0.045 ] },
            { "items": [ -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

id	bimGetCatalogItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogitems

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

Example: https://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

unit

string

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.

filter

string

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

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog item

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

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

id	bimCreateCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

Example: https://api-stage.bimplus.net/v2/catalogs

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog
name	mandatory	string	Catalog name
description	optional	string	Catalog description
catalogtype	mandatory	object	Catalog type object. Mandatory is only Id of the catalog type object. See response of Get a list of catalog types
norms	optional	JSON array	Array of norm objects, see json response part of Get the norm list . Mandatory is only Id of the norm object
countries	optional	JSON array	Array of country objects, see json response part of Get the country list . Mandatory is only Id of the country object

Card

label	HTTP Method

POST

Card

label	Description

Create a new catalog.

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":"Timber",
  "description":"Timber",
  "catalogtype":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496"
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

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

id	bimGetCatalogList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

Example: https://api-stage.bimplus.net/v2/catalogs

Card

label	HTTP Method

GET

Card

label	Description

Gets the catalog list

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

[{
    "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":[{

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {
        "id": "44ad058b-1f76-4343-bafa-031eb462215c",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:17",
        "unreadBrowserNotification": true,
        "unreadEmail": false,
        "correlationId": null
    },
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED",
        "timestampid": "2014-04-08T08:54:41",7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
   "unreadBrowserNotification": false],
        "unreadEmailcatalogType": false,{
        "correlationIdid": "de96f4ae992bdb90-79fde093-4d834e6d-99e982cd-07cec7a80906d8395ec14496",
     } "name":"Material",
      {"description":"Material"
    },
    "id": "ffd500962e5f209b-fb8298e4-4029f731-8d499f54-06a04e31f02af9ade4a87587",
        "receivername": {
      "Aluminium",
      "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
     "description":"Aluminium"
  }
]

Anchor

	getCatalog
	getCatalog

Get the catalog details

Deck of Cards

id	bimGetCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog

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

{
  "norms":[{
       "id": "71e0ac3b96b6d63f-fa497d86-e5402270-ac2f5ded-8caff3dd72eda7868308679b",
     
       "emailname": "testuser2@bimplus.netEC"
    }
    }],
        "source": "IssueService","countries":[{
        "topicid": "ISSUE_DELETED"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "severityname":"Standard "InfoEN",
    }
  ],
  "returnCodecatalogType": "ISSUE_DELETED",{
        "timestampid": "2014992bdb90-e093-05-09T09:54:274e6d-82cd-d8395ec14496",
        "unreadBrowserNotificationname": false"Material",
    "description":"Material"
  },
  "unreadEmailid": true"ae2122c0-f667-f242-40ee-3e57161e433a",
      "name":"Concrete",
  "correlationIddescription": null
    }
]"Concrete"
}

Anchor

	getAllMessagesSentByUserToUsersputCatalog	getAllMessagesSentByUserToUsers

...

	putCatalog

Update the specified catalog

Deck of Cards

id	bimGetAllMessagesSentByUserToUsersbimPutCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource:

user/<user_id>/messages/sent

catalogs

URL: https://api-stage.bimplus.net/v2/user catalogs/<user<catalog_id>/messages/sent

Example: https://api-stage.bimplus.net/v2/usercatalogs/1110ac3bae2122c0-fa49f667-e540f242-ac2f-8caff3dd72ed/messages/sent40ee-3e57161e433a

Card

label	HTTP Method

GET PUT

Card

label	Description

Gets the list of all messages sent from user (user_id) to all single users Update the specified catalog.

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

[{
    "idnorms":"481713d6-7dab-410c-8c8a-d65ff1d4a766",
    "sender":[{
      "id":"1110ac3b0da7bbc8-fa49c63d-e540d090-ac2fc458-8caff3dd72ed1431f78987e0",
      "emailname":"customer1@bimplus.net"
    },
    "receiver":{
      "id":"1e2223b-fa49-e540-ac2f-8caff3dd72edEuropean",
      "emaildescription":"customer2@bimplus.netEuropean"
    },
  ],
  "sourcecountries":"ServiceName2",[],
  "catalogType":{
    "topicid":"SKETCHUP_JOB992bdb90-e093-4e6d-82cd-d8395ec14496",
    "severityname":"InfoMaterial",
    "returncodedescription":"FILE_TOO_BIGMaterial",
  },
  "timestampname":"2013-11-18T14:55:22Concrete X",
    "unreadBrowserNotification":false,
    "unreadEmail":false,
    "additionaldata":null,
    "correlationid":null
  },
  {
"description":"Concrete"
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "norms":[{
      "id":"93c29c5d0da7bbc8-1391c63d-4ae8d090-8876c458-ef9815e60f7d1431f78987e0",
    "sender":{
      "id":"1110ac3b-fa49-e540-ac2f-8caff3dd72edname":"European",
      "emaildescription":"customer1@bimplus.netEuropean"
    }
  ],
  "countries":[],
  "receivercatalogType":{
      "id":"1e2223b992bdb90-fa49e093-e5404e6d-ac2f82cd-8caff3dd72edd8395ec14496",
      "emailname":"customer2@bimplus.net"
    }Material",
    "sourcedescription":"ServiceNameMaterial",
    "topic":"IFC_JOB"},
    "severityid":"Infoae2122c0-f667-f242-40ee-3e57161e433a",
    "returncodename":"OKConcrete X",
    "timestampdescription":"2013-11-18T14:30:53",
    "unreadBrowserNotification":true,
    "unreadEmail":false,
    "additionaldata":null,
    "correlationid":null
  }
]

...

Concrete"
}

Anchor

	getCatalogItemList
	getCatalogItemList

Get the catalog item list from the specified catalog

Deck of Cards

id	bimGetCatalogItemList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs/<catalog_id>/items

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

Example: https://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

...

Get all messages sent by given user to all groups

Deck of Cards

id	bimGetAllMessagesSentByUserToGroups

Card

default	true
label	URL / Resource / JSON Structure

Resource: user/<user_id>/messages/groupsent

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

Example:

Name

Type

Default value

Description

code

string

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

norm

string

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/

user

1110ac3b

fa49

e540

ac2f

8caff3dd72ed/messages/groupsent

Card

label	HTTP Method

GET

Card

label	Description

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

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

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

...

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
na	string	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
country	string	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
filter	string	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. https://api-stage.bimplus.net/v2/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/catalogs/2d116846-5f7c-a780-3a82-6dd8150989df/items?filter=name=S 998&code=DIN 1045&country=Germany

Card

label	HTTP Method

GET

Card

label	Description

Get all catalog items of the catalog

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

[{
    "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)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"02ce9b8b-720c-a44c-b115-f45a0de7d965",
    "name":"GL 32c",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"0e00c600-8004-6a03-8110-4d38c3dc40aa",
    "name":"GL 24h",
    "description":"(EN 14080)"

...

Get all messaging groups

Deck of Cards

id	bimGetAllMessagingGroups

Card

default	true
label	URL / Resource / JSON Structure

Resource: systemgroups

URL: https://api-stage.bimplus.net/v2/systemgroups

Example: https://api-stage.bimplus.net/v2/systemgroups

Card

label	HTTP Method

GET

Card

label	Description

Gets all existing messaging groups.

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

[{
    "systemGroup":{
      "id":"9c3c8a6c-67b5-406f-a44c-0dca6eb3c031",
      "name":"Users from Munich",
      "description":"Group of users from Munich area"
    },
    "usersIdList":["6ae90098-5b01-4141-8ef5-0079ae6c1c04",
      "9d32f46b-157f-dfee-a5d7-0162543dc304",
      "a33e89a2-b5fc-408a-b4ec-01fb593e2b1d"
    ]
  },
  {
    "systemGroupcatalogId":{
 "10e3f185-234e-9686-5fea-73075149abd2",
     "id":"242fab5afb3bfbb8-fce6aa6a-441364b3-900bb78e-5f5b6ca2a4148950ca107891",
      "name":"UsersGL from 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

Status: 200 OK

Deck of Cards

id	bimGetMessagingGroupDetailsbimDeleteCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource:

systemgroups/<messaginggroup_id>

catalogs

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

Example: https://api-stage.bimplus.net/v2/systemgroupscatalogs/242fab5aae2122c0-fce6f667-4413f242-900b40ee-5f5b6ca2a4143e57161e433a

Card

label	HTTP Method

GET

Card

label	Description

Get details of a specified messaging group. Description of returned json in Create a new messaging group.

DELETE

Card

label	Description

Delete the specified catalog

Card

label	Request

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

Code Block

borderColor	RedGreen
lang	xml
title	JSON	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 2

New Version Current

Key

Catalog Service

Catalog Service

Create a new norm

Create a new norm

Get the norm list

Get the norm details

Delete the specified norm

Create a new country

Get the country list

Mark a browser message as "unread"

Mark an email message as "unread"

Get the country details

Delete the specified country

Filter the messages (eg: Get all the unread messages from a particular user)

Anchor
getCatalogTypesList
getCatalogTypesList

Get a list of catalog types

Get the catalog type details

Create a new catalog item

Get the catalog item details

Create a new catalog

Get the catalog list

Get the catalog details

Update the specified catalog

Get the catalog item list from the specified catalog

Get all messages sent by given user to all groups

Get all messaging groups

Delete the specified catalog

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

Catalog Service

Catalog Service

Create a new norm

Create a new norm

Get the norm list

Get the norm details

Delete the specified norm

Create a new country

Get the country list

Mark a browser message as "unread"

Mark an email message as "unread"

Get the country details

Delete the specified country

Filter the messages (eg: Get all the unread messages from a particular user)

AnchorgetCatalogTypesListgetCatalogTypesList

Get a list of catalog types

Get the catalog type details

Create a new catalog item

Get the catalog item details

Create a new catalog

Get the catalog list

Get the catalog details

Update the specified catalog

Get the catalog item list from the specified catalog

Get all messages sent by given user to all groups

Get all messaging groups

Delete the specified catalog

Anchor
getCatalogTypesList
getCatalogTypesList