Page History

...

Messaging Service

...

Anchor

	createMessage
	createMessage

...

Anchor

	putDashboardMessage
	putDashboardMessage

Modify

...

contents of the dashboard

...

messages

Deck of Cards

id	bimModifyDashboardMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/updatedashboardadditionaldata

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

Example: https://api-stage.bimplus.net/v2/messages/b8615afc-99cc-4bcd-b0ca-ff0593ce15c6/updatedashboardadditionaldata

JSON Structure:

Name	Mandatory / Optional	Type	Description
additionalData	mandatory	object	The content of the message

JSON Structure of the object additionalData

Name	Mandatory / Optional	Type	Description
title	mandatory	string	Title of the message
content	mandatory	string	Message text content
imageBase64	optional	string
pictureLink	optional	string
messageLink	optional	string

Card

label	HTTP Method

PUT

Card

label	Description

Update

Update the content of the dashboard message or the contents of the grouped dashboard messages by given posting.

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

{
  "additionalData":{
    "title":"Anothermessage",
    "content":"Loremipsumdolorsitamet,consetetursadipscingelitr",
    "imageBase64":null,
    "pictureLink":"http://blog.bimplus.net/wp-content/uploads/2014/08/bim-manager-300x222.png",
    "messageLink":""
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

title	JSON

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "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": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unreadBrowserNotification": true,
    "timestamp": "2013-11-15T10:55:53"
}

...

Anchor

	deleteMessage
	deleteMessage

Delete the specified message

Deck of Cards

id	bimDeleteMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>

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

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

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified message or group of messages by given posting.

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

Mark a browser message as "read"

Deck of Cards

id	bimBrowserMessageRead

Card

label
default	true

...

Delete the specified message

Deck of Cards

id	bimDeleteMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id> 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

DELETE POST

Card

label	Description

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

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

...

browserMessageUnread

...

browserMessageUnread

Mark a browser message as "

...

unread"

Deck of Cards

id	bimBrowserMessageReadbimBrowserMessageUnead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasreadbrowser markasunreadbrowser

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

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

Card

label	HTTP Method

POST

Card

label	Description

Mark

Mark a message

as read

or group of messages by given posting as unread by browser.

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

...

emailMessageUnread

...

emailMessageUnread

Mark

...

an email message as "unread"

Deck of Cards

id	bimBrowserMessageUneadbimEmailMessageUnread

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasunreadbrowser markasunreademail

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

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

Card

label	HTTP Method

POST

Card

label	Description

Mark a an email message as unread by browser.

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

...

	messageFilter

...

	messageFilter

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

...

Deck of Cards

id	bimEmailMessageUnreadbimGetMessageList

Card

default	true
label	URL / Resource / JSON Structure

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

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

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

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

Card

label	HTTP Method

POST GET

Card

label	Description

Mark an email message as unread. 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",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {

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",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplustestuser1@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueServicesource": "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",
        "timestamp": "2014-04-08T08:54:41",
        "unreadBrowserNotification": false,
        "unreadEmail": false,
        "correlationId": "de96f4ae-79fd-4d83-99e9-07cec7a80906"
    },
    {
        "id": "ffd50096-fb82-4029-8d49-06a04e31f02a",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "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
    }
]

...

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: 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"
    },
    "receivergroup":{
      "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,
    "groupId":"0c82421d-1ca9-4b6a-b6bb-eb5ddcb79760"
  },
  {
    "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,
    "groupId":"0c82421d-1ca9-4b6a-b6bb-eb5ddcb79760"
  }
]

...

Create a new messaging group

...

id	bimCreateMessagingGroup

...

default	true
label	URL / Resource / JSON Structure

...

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

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

JSON Structure:

...

Name

...

Mandatory / Optional

...

Type

...

Description

...

systemGroup

...

mandatory

...

object

...

The object contains information about group to be created where :

Id is optional property as string(guid)
name mandatory property as string. Must be unique name
description option property as string

...

usersIdList

...

mandatory

...

list of string(guid)

...

List of user id’s belonging to the group. User list requires valid user identifiers.

Card

label	HTTP Method

POST

...

label	Description

...

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

{
  "systemGroup":{
    "name":"Bimplusdevelopers",
    "description":"GroupofBimplusdevelopers"
  },
  "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
    "6be10633-5950-319f-eae0-12dec2c04219",
    "2e798f29-4b71-15ee-90eb-18592bc18317"
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "systemGroup":{
    "id":"df0f426c-b972-4c16-9839-c77ac5930bcc",
    "name":"Bimplusdevelopers",
    "description":"GroupofBimplusdevelopers"
  },
  "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
    "6be10633-5950-319f-eae0-12dec2c04219",
    "2e798f29-4b71-15ee-90eb-18592bc18317"
  ]
}

...

Get all messaging groups

Deck of Cards

id	bimGetAllMessagingGroups

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/systemgroups

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

Example: https://api-stage.bimplus.net/v2/messages/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-0162543dc304name":"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",
      "a33e89a2-b5fc-408a-b4ec-01fb593e2b1d"
    ]
"email":"customer1@bimplus.net"
    },
  {
    "systemGroupgroup":{
      "id":"242fab5a594bbc5d-fce61949-44134d74-900b84d3-5f5b6ca2a414B966a42c68A1",
      "name":"Users from ParisFrance",
      "description":"Group of users from ParisFrance"
    },
    "source":"DashboardNews",
    "topic":"DASHBOARD",
    "severity":"Info",
    "returncode":"OK",
    "usersIdListtimestamp":["61c9c3252013-52a2-21b5-47b6-0a06e7152ff9"11-18T14:30:53",
    "unreadBrowserNotification":true,
      "6be10633-5950-319f-eae0-12dec2c04219",
      "2e798f29-4b71-15ee-90eb-18592bc18317""unreadEmail":false,
    "additionalData":"{ Test message to group France}",
    ]"correlationid":null
  }
]

Anchor

	getMessagingGroupDetailsgetAllMessagingGroupsgetMessagingGroupDetails
	getAllMessagingGroups

Get

...

all messaging

...

groups

Deck of Cards

id	bimGetMessagingGroupDetailsbimGetAllMessagingGroups

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/systemgroups/<messaginggroup_id> systemgroups

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

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

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

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"
    ]
  },
  {
    "systemGroup":{

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "systemGroup":{
    "id":"242fab5a-fce6-4413-900b-5f5b6ca2a414",
      "name":"BimplusdevelopersUsers from Paris",
      "description":"Group of users from Paris"
    },
    "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
      "6be10633-5950-319f-eae0-12dec2c04219",
      "3b6380752e798f29-24cd4b71-cb2b15ee-546490eb-fa955d2bd1e018592bc18317"
    ]
}  }
]

Anchor

	deleteMessagingGroupgetMessagingGroupDetailsdeleteMessagingGroup
	getMessagingGroupDetails

...

Get the messaging group details

Deck of Cards

id	bimDeleteMessagingGroupbimGetMessagingGroupDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/ systemgroups/<messaginggroup_id>

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

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

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes a specified messaging group.

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

Request

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Card

label

Code Block

borderColor	GreenRed
lang	xml
title	Headers

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

Card

label	Response


title	JSON

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

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 28

New Version Current

Key

Messaging Service

Modify

contents of the dashboard

messages

Delete the specified message

Anchor
browserMessageRead
browserMessageRead

Mark a browser message as "read"

Delete the specified message

Anchor

browserMessageUnread

browserMessageUnread

Mark a browser message as "

unread"

Anchor

emailMessageUnread

emailMessageUnread

Mark

an email message as "unread"

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

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

Create a new messaging group

Get all messaging groups

Get

all messaging

groups

Get the messaging group details

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 28

New Version Current

Key

Messaging Service

Modify

contents of the dashboard

messages

Delete the specified message

AnchorbrowserMessageReadbrowserMessageRead

Mark a browser message as "read"

Delete the specified message

Anchor

browserMessageUnread

browserMessageUnread

Mark a browser message as "

unread"

Anchor

emailMessageUnread

emailMessageUnread

Mark

an email message as "unread"

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

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

Create a new messaging group

Get all messaging groups

Get

all messaging

groups

Get the messaging group details

Anchor
browserMessageRead
browserMessageRead