Page History

Catalog Service

...

Get the catalog item details

Get all messages sent by given user to all groups

Catalog Service

...

Anchor

	createNormgetNormList	createNorm

...

	getNormList

Get the norm list

Deck of Cards

id	bimCreateNormbimGetNormList

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms/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	HTTP Method

GET

Card

label	Description

Gets the norm list

Card

label

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	RedGreen
lang	xml
title	JSON

{
  "name":"DIN 1046",
  "description":"DIN 1046"
}

Card

label	Response

Status

Status: 200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

[{
    "id":"ed9fe5ba6de06146-96c0125f-f24dc7eb-977995cc-b06b7ce693850c07d85c4d94",
    "name":"DIN 10461045",
    "description":"DIN 10461045"
}

...

  },
  {
    "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
    "name":"DIN 17100",
    "description":"DIN 17100"
  }
]

Anchor

	getNorm
	getNorm

Get the norm details

...

Deck of Cards

id	bimGetNormListbimGetNorm

Card

default	true
label	URL / Resource / JSON Structure

Resource: /norms norms

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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the norm list 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"
  },
  {
    "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
    "name":"DIN 17100",
    "description":"DIN 17100"
  }
]

...

Anchor

	getCountryList
	getCountryList

Get the country list

Deck of Cards

id	bimGetCountryList

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

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

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

Card

label	HTTP Method

GET

Card

label	Description

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	Red

...

Get the norm details

Deck of Cards

id	bimGetNorm

Card

default	true
label	URL / Resource / JSON Structure

Resource: norms

URL: https://api-stage.bimplus.net/v2/ norms/<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

JSON

[{

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "id":"6de061462909b0d8-125fc6de-c7eb425d-95cc2303-0c07d85c4d94256336ada04f",
    "name":"DIN 1045Germany",
    "description":"DIN 1045Germany"
}

...

  },
  {
    "id":"b7e10710-94f8-bfdf-72a0-eaa80f3bc57e",
    "name":"Italy",
    "description":"Italy"
  }
]

Anchor

	getCountry
	getCountry

Get the country details

...

Deck of Cards

id	bimDeleteNormbimGetCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: normscountries

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

Example: https://api-stage.bimplus.net/v2/normscountries/6de06146ed9fe5ba-125f96c0-c7ebf24d-95cc9779-0c07d85c4d94 b06b7ce69385

Card

label	HTTP Method

DELETE GET

Card

label	Description

Delete the specified norm Get information about a 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

...

Code Block

...

borderColor

...

Create a new country

Red
lang	xml
title	JSON

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

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

Deck of Cards

id	bimCreateCountry

Card

default	true
label	URL / Resource / JSON Structure

Resource: countries

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

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

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

JSON JSON Structure:

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

Card

label	HTTP Method

POST GET

Card

label	Description

Create a new country. 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	RedGreen
lang	xml
title	JSONStatus

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

Card

label	Response

200 OK

Code Block

borderColor	GreenRed
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

[{
    "id":"ed9fe5ba992bdb90-96c0e093-f24d4e6d-977982cd-b06b7ce69385d8395ec14496",
    "name":"AustriaMaterial",
    "description":"AustriaMaterial"
  },
  ...
]

Anchor

	getCountryListgetCatalogTypegetCountryList
	getCatalogType

Get the

...

catalog type details

Deck of Cards

id	bimGetCountryListbimGetCatalogType

Card

default	true
label	URL / Resource / JSON Structure

Resource: countriescatalogs/types

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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the country list 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":"2909b0d8992bdb90-c6dee093-425d4e6d-230382cd-256336ada04fd8395ec14496",
    "name":"GermanyMaterial",
    "description":"GermanyMaterial"
  },
  {
    "id":"b7e10710-94f8-bfdf-72a0-eaa80f3bc57e",
    "name":"Italy",
    "description":"Italy"
  }
]

...

Anchor

	getCatalogItem
	getCatalogItem

Get the catalog item

...

details

Deck of Cards

id	bimGetCountrybimGetCatalogItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: countriescatalogitems

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

Example: https://api-stage.bimplus.net/v2/countriescatalogitems/ed9fe5baf15e402a-96c0d29d-f24d023c-9779745d-b06b7ce693852b2f41c58483

Card

label	HTTP Method

GET

Card

label	Description

Get information about a 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

Code Block

borderColor	Red
lang	xml
title	JSON

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

...

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

...

Delete the specified norm

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

Deck of Cards

id	bimDeleteCountry

Card

default	true
label	URL / Resource / JSON Structure

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified country

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	HeadersStatus

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

Card

label	Response

200 OK

Code Block

borderColor	GreenRed
lang	xml
title	StatusJSON

Status:{
 200 OK

...

Mark a browser message as "read"

...

id	bimBrowserMessageRead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasreadbrowser

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

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

Card

label	HTTP Method

POST

Card

label	Description

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

 "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

	getCatalogList
	getCatalogList

Get the catalog list

Deck of Cards

id	bimGetCatalogList

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Mark a browser message as "read"

...

id	bimBrowserMessageRead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasreadbrowser

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

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

Card

label	HTTP Method

POST

Card

label	Description

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

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

Mark a browser message as "unread"

Deck of Cards

id	bimBrowserMessageUnead

Card

default	true
label	URL / Resource / JSON Structure

Resource:

messages/<message_id>/markasunreadbrowser

catalogs

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

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

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

...

Mark an email message as "unread"

...

id	bimEmailMessageUnread

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

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.

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

...

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

...

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

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

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

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified message

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": "44ad058b-1f76-4343-bafa-031eb462215c",
        "receivername": {"EC"
      }
      ],
    "countries":[{
        "id": "71e0ac3b7a286f49-fa49ca3e-e540f2c9-ac2f2555-8caff3dd72edaf6f9713071c",
            "emailname": "customer@bimplus.net"Standard EN"
        },
    ],
    "sendercatalogType": {
            "id": "71e0ac3b992bdb90-fa49e093-e5404e6d-ac2f82cd-8caff3dd72edd8395ec14496",
            "email"name": "testuser1@bimplus.netMaterial",
      "description":"Material"
    },
        "sourceid": "IssueService"ae2122c0-f667-f242-40ee-3e57161e433a",
        "topicname": "ISSUE_DELETEDConcrete",
        "severitydescription": "InfoConcrete",
  },
  {
    "returnCodenorms": "ISSUE_DELETED",[{
        "timestampid": "2014-05-09T09:54:1796b6d63f-7d86-2270-5ded-a7868308679b",
        "unreadBrowserNotificationname": true,
        "unreadEmail": false,"EC"
        "correlationId": null}
    }],
    "countries":[{
        "id": "0a4c8eab7a286f49-26afca3e-49cef2c9-91912555-049a141ba762af6f9713071c",
        "receivername":"Standard {EN"
      }
    ],
    "idcatalogType":{
 "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed     "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
            "email"name": "customer@bimplus.net"
        }Material",
        "senderdescription": {"Material"
    },
        "id": "71e0ac3b2e5f209b-fa4998e4-e540f731-ac2f9f54-8caff3dd72edf9ade4a87587",
    "name":"Aluminium",
        "emaildescription": "testuser1@bimplus.netAluminium"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED",
        "timestamp": "2014-04-08T08:54:41",
  
]

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":"96b6d63f-7d86-2270-5ded-a7868308679b",
      "unreadBrowserNotificationname": false,"EC"
    }
  ],
  "unreadEmailcountries": false,[{
        "correlationIdid": "de96f4ae7a286f49-79fdca3e-4d83f2c9-99e92555-07cec7a80906af6f9713071c",
    },  "name":"Standard EN"
    {}
  ],
  "catalogType":{
    "id": "ffd50096992bdb90-fb82e093-40294e6d-8d4982cd-06a04e31f02ad8395ec14496",
        "receivername": {"Material",
    "description":"Material"
  },
      "id": "71e0ac3bae2122c0-fa49f667-e540f242-ac2f40ee-8caff3dd72ed3e57161e433a",
            "email"name": "customer@bimplus.net"
        },
      Concrete",
  "senderdescription": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser2@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:27",
        "unreadBrowserNotification": false,
        "unreadEmail": true,
        "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 single users

Deck of Cards

id	bimGetAllMessagesSentByUserToUsers

Card

default	true
label	URL / Resource / JSON Structure

Resource: user/<user_id>/messages/sentURL:

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.

...

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

...

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/

user/<user_id>/messages/sent

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

Card

label	HTTP Method

GET

Card

label	Description

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

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"
    },
    "receiver":{
      "id":"1e2223b-fa49-e540-ac2f-8caff3dd72ed",
      "email":"customer2@bimplus.net"
    },
    "source":"ServiceName2",
    "topic":"SKETCHUP_JOB",
    "severity":"Info",
    "returncode":"FILE_TOO_BIG",
    "timestamp":"2013-11-18T14:55:22",
    "unreadBrowserNotification":false,
    "unreadEmail":false,
    "additionaldata":null,
    "correlationid":null
  },
  {
    "id":"93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "sender":{
      "id":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
      "email":"customer1@bimplus.net"
    },
    "receiver":{
      "id":"1e2223b-fa49-e540-ac2f-8caff3dd72ed",
      "email":"customer2@bimplus.net"
    },
    "source":"ServiceName",
    "topic":"IFC_JOB",
    "severity":"Info",
    "returncode":"OK",
    "timestamp":"2013-11-18T14:30:53",
    "unreadBrowserNotification":true,
    "unreadEmail":false,
    "additionaldata":null,
    "correlationid":null
  }
]

...

Get all messages sent by given user to all groups

...

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: 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

...

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Status: 200 OK

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/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
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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets all existing messaging groups. 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

Request

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

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"
    },
    "usersIdListcatalogId":["6ae9009810e3f185-5b01234e-41419686-8ef55fea-0079ae6c1c0473075149abd2",
      "9d32f46b-157f-dfee-a5d7-0162543dc304"id":"754da75a-c96d-6d4f-01a9-33a178394ecb",
      "a33e89a2-b5fc-408a-b4ec-01fb593e2b1d""name":"GL 26h",
    ]"description":"(EN 14080)"
  },
  {
    "systemGroupcatalogId":{
  "10e3f185-234e-9686-5fea-73075149abd2",
    "id":"242fab5a27d2555d-fce62245-4413a84a-900b7950-5f5b6ca2a414a4898077261f",
      "name":"UsersGL from Paris30h",
      "description":"Group of users from Paris(EN 14080)"
  },
  },{
    "usersIdListcatalogId":["61c9c32510e3f185-52a2234e-21b59686-47b65fea-0a06e7152ff973075149abd2",
      "6be10633-5950-319f-eae0-12dec2c04219"id":"02ce9b8b-720c-a44c-b115-f45a0de7d965",
    "name":"GL 32c",
    "2e798f29-4b71-15ee-90eb-18592bc18317description":"(EN 14080)"
    ]},
  }
]

...

Get the messaging group details

Deck of Cards

id	bimGetMessagingGroupDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: systemgroups/<messaginggroup_id>

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

Example: https://api-stage.bimplus.net/v2/systemgroups/242fab5a-fce6-4413-900b-5f5b6ca2a414

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.

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":{{
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"0e00c600-8004-6a03-8110-4d38c3dc40aa",
    "name":"GL 24h",
    "description":"(EN 14080)"
  },
  {
    "catalogId":"10e3f185-234e-9686-5fea-73075149abd2",
    "id":"242fab5afb3bfbb8-fce6aa6a-441364b3-900bb78e-5f5b6ca2a4148950ca107891",
    "name":"BimplusdevelopersGL 28h",
    "description":"(EN 14080)"
  },
  {
    "usersIdListcatalogId":["61c9c32510e3f185-52a2234e-21b59686-47b65fea-0a06e7152ff973075149abd2",
    "6be10633-5950-319f-eae0-12dec2c04219id":"9be0c733-243d-2e1c-c79c-7be0a2b6c1a3",
    "3b638075-24cd-cb2b-5464-fa955d2bd1e0"
  ]
}"name":"GL 32h",
    "description":"(EN 14080)"
  }
]

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Catalog Service

Get the norm list

Get the norm details

Get the country list

Get the norm details

Get the country details

Create a new country

Anchor
getCatalogTypesList
getCatalogTypesList

Get a list of catalog types

Get the

catalog type details

Get the catalog item

details

Delete the specified norm

Mark a browser message as "read"

Get the catalog list

Mark a browser message as "read"

Mark a browser message as "unread"

Mark an email message as "unread"

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

Get the catalog details

Get the catalog item list from the specified catalog

Get all messages sent by given user to all single users

Get all messaging groups

Get all messages sent by given user to all groups

Get the messaging group details

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Catalog Service

Get the norm list

Get the norm details

Get the country list

Get the norm details

Get the country details

Create a new country

AnchorgetCatalogTypesListgetCatalogTypesList

Get a list of catalog types

Get the

catalog type details

Get the catalog item

details

Delete the specified norm

Mark a browser message as "read"

Get the catalog list

Mark a browser message as "read"

Mark a browser message as "unread"

Mark an email message as "unread"

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

Get the catalog details

Get the catalog item list from the specified catalog

Get all messages sent by given user to all single users

Get all messaging groups

Get all messages sent by given user to all groups

Get the messaging group details

Anchor
getCatalogTypesList
getCatalogTypesList