Versions Compared

Key

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

Catalog Service

...


Catalog Service

...


Anchor
createNormgetNormListcreateNorm

...

getNormList

Get the norm list
Deck of Cards
idbimCreateMessagebimGetNormList


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: norms/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
labelHTTP Method
 GET


Card
labelDescription
 Gets the norm list


Card
label
Card
labelRequest


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



Response
Card
labelResponse


Code Block
borderColorRedGreen
langxml
titleJSONStatus
{
Status:  "name":"DIN 1046",
  "description":"DIN 1046"
}
Card
label
200 OK


Code Block
borderColorGreenRed
langxml
titleStatus
Status: 201 Created
Code Block
titleJSON
[{
    "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
Anchor
getNormListgetNormList

Get the norm

...

details
Deck of Cards
idbimGetCurrentMessageListbimGetNorm


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: /norms 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
 Gets the norm list 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"
  },
  {
    "id":"0da7bbc8-c63d-d090-c458-1431f78987e0",
    "name":"DIN 17100",
    "description":"DIN 17100"
  }
]

...

}





Anchor
getCountryList
getCountryList

Get the country list
Deck of Cards
idbimGetCountryList


Card
defaulttrue

...

Get the norm details
Deck of Cards
idbimGetMessage
Card
defaulttrue
labelURL / Resource / JSON Structure

Resource:

norms

countries

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

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


Card
labelHTTP Method
 GET


Card
labelDescription
 Get information about a specified norm 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":"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
idbimGetCountry

...

Delete the specified norm
Deck of Cards
idbimDeleteMessage


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: normscountries

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

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


Card
labelHTTP Method
 DELETE GET


Card
labelDescription
Delete the specified norm 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

...

borderColor

...

Mark a browser message as "read"
Red
langxml
titleJSON
{
  "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385",
  "name":"Austria",
  "description":"Austria"
}




Anchor
getCatalogTypesList
getCatalogTypesList
Get a list of catalog types
Deck of Cards
idbimGetCatalogTypesList


Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: catalogs/types

Deck of Cards
idbimBrowserMessageRead
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id>/markasreadbrowser 

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

...

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



Anchor
getCatalogType
getCatalogType

Get the catalog type details
Deck of Cards
idbimGetCatalogType


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource: catalogs/types

URLhttps://api-

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 

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

Card
labelHTTP Method
 POST

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

Card
labelDescription

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


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

...

borderColor

...

Mark an email message as "unread"
Red
langxml
titleJSON
{
  "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
  "name":"Material",
  "description":"Material"
}




Anchor
getCatalogItem
getCatalogItem

Get the catalog item details
Deck of Cards
idbimGetCatalogItem
Deck of Cards
idbimEmailMessageUnread


Card
defaulttrue
labelURL / Resource / JSON Structure

Resource:

messages/<message_id>/markasunreademail 

catalogitems

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

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

Card
labelHTTP Method
 POST
Card
labelDescription
 Mark an email message as unread.
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/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.

...

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....URL:messages

catalogitems?filter=

unread=true%26receiver.email=customer@bimplus.net%26source=IssueService

name=I1

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

 

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 messagecatalog 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
[
    {
        "id": "44ad058b-1f76-4343-bafa-031eb462215c"catalogId":"2d116846-5f7c-a780-3a82-6dd8150989df",
        "receiver"properties": {
    "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4":"1.2e-05",
        "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed"029ca99d-d590-3f36-60ad-c2f8538b6bf4":"No",
     "9df611ca-c547-e0ab-4595-8a017a383592":210000000000,
       "email": "customer@bimplus.net""ca5d193d-c7c8-be57-a244-e7d751a67824":80769200000,
        },
   "ceb34ade-8a26-f9a5-b3ea-f247486a1778":7850,
     "sender": {"52941ec9-f125-d765-aaca-07c7a3e86997":0.3,
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
  "efd8c210-8d8e-21e6-987f-8924159f961f":0.15,
          "email": "testuser1@bimplus.net""c905659b-74c8-dd27-7c61-e9722abbf9a3":600,
        }"9813d85d-cd87-1db0-a4ce-08a94375ecae":45,
        "source": "IssueService""633a90c2-a927-faf3-22d4-7a17e4f2b81a":355000000,
    "d450c196-451f-6811-0b47-53c5b81f2cc9":470000000
  },
  "topicid": "ISSUE_DELETED"f15e402a-d29d-023c-745d-2b2f41c58483",
        "severityname":"S "Info998",
        "returnCodedescription":"test catalog item "
}




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":[ "ISSUE_DELETED",
        "timestamp": "2014-05-09T09:54:17",
        "unreadBrowserNotification": true,
        "unreadEmail": false,
        "correlationId": null
    },
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b96b6d63f-fa497d86-e5402270-ac2f5ded-8caff3dd72eda7868308679b",
            "emailname": "customer@bimplus.netEC"
        },
    ],
    "sendercountries": [{
            "id": "71e0ac3b7a286f49-fa49ca3e-e540f2c9-ac2f2555-8caff3dd72edaf6f9713071c",
            "emailname":"Standard EN"testuser1@bimplus.net"
        },
    ],
    "sourcecatalogType": "IssueService",{
        "topicid": "ISSUE_UPDATED"992bdb90-e093-4e6d-82cd-d8395ec14496",
        "severityname": "InfoMaterial",
        "returnCodedescription": "ISSUE_UPDATEDMaterial",
    },
    "timestampid": "2014-04-08T08:54:412d116846-5f7c-a780-3a82-6dd8150989df",
        "unreadBrowserNotificationname": false"Steel",
        "unreadEmaildescription": false"Steel"
  },
   {
     "correlationId": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
    },
    norms":[{
        "id": "ffd5009696b6d63f-fb827d86-40292270-8d495ded-06a04e31f02aa7868308679b",
        "receivername":"EC"
  {
    }
    ],
    "idcountries": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",[{
            "emailid": "customer@bimplus.net""7a286f49-ca3e-f2c9-2555-af6f9713071c",
        },"name":"Standard EN"
      }
    ],
    "sendercatalogType": {
            "id": "71e0ac3b992bdb90-fa49e093-e5404e6d-ac2f82cd-8caff3dd72edd8395ec14496",
      "name":"Material",
      "emaildescription": "testuser2@bimplus.netMaterial"
    },
    }"id":"ae2122c0-f667-f242-40ee-3e57161e433a",
    "name":"Concrete",
    "sourcedescription": "IssueServiceConcrete",
  },
  {
    "topicnorms": "ISSUE_DELETED",[{
        "severityid": "Info"96b6d63f-7d86-2270-5ded-a7868308679b",
        "returnCodename": "ISSUE_DELETEDEC",
      }
   "timestamp ],
    "countries":[{
 "2014-05-09T09:54:27       "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "unreadBrowserNotificationname":"Standard false,EN"
      }
  "unreadEmail": true  ],
        "correlationIdcatalogType":{
  null
    }
]

...

"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

...

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
titleStatusHeaders
StatusAuthorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json



Card
labelResponse


Code Block
borderColorGreen
langxml
titleStatus
Status: 200 200 OK


Code Block
borderColorRed
langxml
titleJSON
{
  "norms":[{
      "id":"481713d696b6d63f-7dab7d86-410c2270-8c8a5ded-d65ff1d4a766a7868308679b",
      "sendername":{"EC"
    }
  ],
  "idcountries":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed[{
      "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
      "emailname":"customer1@bimplus.netStandard EN"
    },
  ],
  "receivercatalogType":{
      "id":"1e2223b992bdb90-fa49e093-e5404e6d-ac2f82cd-8caff3dd72edd8395ec14496",
      "emailname":"customer2@bimplus.net"
    }Material",
    "sourcedescription":"ServiceName2Material",
  },
  "topicid":"SKETCHUP_JOBae2122c0-f667-f242-40ee-3e57161e433a",
    "severityname":"InfoConcrete",
    "returncodedescription":"FILE_TOO_BIGConcrete",
    "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
  }
]

...


}




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

...

Get all messages sent by given user to all groups
Deck of Cards
idbimGetAllMessagesSentByUserToGroups
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: user/<user_id>/messages/groupsent

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

Example

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.

user1110ac3bfa49e540ac2f8caff3dd72ed/messages/groupsent
Card
labelHTTP Method
 GET
Card
labelDescription

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

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. 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
labelHTTP Method
 GET


Card
labelDescription
 Get all catalog items of the 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
[{
    "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",
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",
      "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":"UsersGL from France30h",
      "description":"Group of users from France(EN 14080)"
  },
  },{
    "sourcecatalogId":"DashboardNews10e3f185-234e-9686-5fea-73075149abd2",
    "topicid":"DASHBOARD02ce9b8b-720c-a44c-b115-f45a0de7d965",
    "severityname":"InfoGL 32c",
    "returncodedescription":"OK"(EN 14080)"
  },
  {
  "timestamp":"2013-11-18T14:30:53",
    "unreadBrowserNotification":true,
    "unreadEmail":false,
    "additionalData":"{ Test message to group France}",
    "correlationid":null
  }
]

...

Get all messaging groups

...

idbimGetAllMessagingGroups
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups 

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets all existing messaging 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
[{
    "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"
    ]
  },
  {
    "systemGroup":{
      "id":"242fab5a-fce6-4413-900b-5f5b6ca2a414",
      "name":"Users from Paris",
      "description":"Group of users from Paris"
    },
    "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
      "6be10633-5950-319f-eae0-12dec2c04219",
      "2e798f29-4b71-15ee-90eb-18592bc18317"
    ]
  }
]

...

Get the messaging group details
Deck of Cards
idbimGetMessagingGroupDetails
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups/<messaginggroup_id>

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of a specified messaging group. Description of returned json in Create a new messaging group.
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
{
  "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)"
  },
  "usersIdList{
    "catalogId":["61c9c32510e3f185-52a2234e-21b59686-47b65fea-0a06e7152ff973075149abd2",
    "id":"6be106339be0c733-5950243d-319f2e1c-eae0c79c-12dec2c042197be0a2b6c1a3",
    "3b638075-24cd-cb2b-5464-fa955d2bd1e0"
  ]
}name":"GL 32h",
    "description":"(EN 14080)"
  }
]