Page History

...

Deck of Cards

id	bimModifyDashboardMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_key>id>/updatedashboardadditionaldata

URL: https://api-stage.bimplus.net/v2/messages/<message_key>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 the content of the dashboard message or the contents of the grouped dashboard messages by given posting (as messageKey).

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

...

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

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

...

Deck of Cards

id	bimBrowserMessageRead

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/<message_id or message_key>id>/markasreadbrowser

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

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

Card

label	HTTP Method

POST

Card

label	Description

Mark a message (as id) or group of messages by given posting ( as messageKey) 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

...

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

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

Card

label	HTTP Method

POST

Card

label	Description

Mark

Mark a message 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

...

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",
      "emailname":"customer2@bimplus.net"Users from Italy",
    },
    "sourcedescription":"ServiceName2"Group of users from Italy"
    },
    "source":"DashboardAnnouncement",
    "topic":"SKETCHUP_JOBDASHBOARD",
    "severity":"Info",
    "returncode":"FILE_TOO_BIG",
    "timestamp":"2013-11-18T14:55:22",
    "unreadBrowserNotification":false,
    "unreadEmail":false,
    "additionaldataadditionalData":null,
    "correlationid":null"{ Test message to group Italy}",
    "groupIdcorrelationid":"0c82421d-1ca9-4b6a-b6bb-eb5ddcb79760"null
  },
  {
    "id":"93c29c5d8757d4c6-1391477b-4ae8419e-8876b0e2-ef9815e60f7d52cbb9e1b1a8",
    "sender":{
      "id":"1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
      "email":"customer1@bimplus.net"
    },
    "receivergroup":{
      "id":"1e2223b594bbc5d-fa491949-e5404d74-ac2f-8caff3dd72ed84d3-B966a42c68A1",
      "name":"Users from France",
      "emaildescription":"customer2@bimplus.netGroup of users from France"
    },
    "source":"ServiceNameDashboardNews",
    "topic":"IFC_JOBDASHBOARD",
    "severity":"Info",
    "returncode":"OK",
    "timestamp":"2013-11-18T14:30:53",
    "unreadBrowserNotification":true,
    "unreadEmail":false,
    "additionaldataadditionalData":null,
"{ Test message to group France}"correlationid":null,
    "groupIdcorrelationid":"0c82421d-1ca9-4b6a-b6bb-eb5ddcb79760"null
  }
]

Anchor

	getAllMessagingGroups
	getAllMessagingGroups

...

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

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 37

New Version Current

Key