Versions Compared

Old Version 46

changes.mady.by.user Peter Balogh

Saved on

compared with

New Version Current

changes.mady.by.user Peter Balogh

Saved on

Key

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

...

Deck of Cards
idbimModifyDashboardMessage
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id or message_key>id>/updatedashboardadditionaldata

URL: https://api-stage.bimplus.net/v2/messages/<message_id or 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
optionalstring
pictureLink
optionalstring
messageLink
optionalstring
Card
labelHTTP Method
 PUT
Card
labelDescription

Update the content of the dashboard message (as id) or the contents of the grouped dashboard messages by given posting (as messageKey).

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
{
  "additionalData":{
    "title":"Anothermessage",
    "content":"Loremipsumdolorsitamet,consetetursadipscingelitr",
    "imageBase64":null,
    "pictureLink":"http://blog.bimplus.net/wp-content/uploads/2014/08/bim-manager-300x222.png",
    "messageLink":""
  }
}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...

Deck of Cards
idbimDeleteMessage
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id or message_key> id> 

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

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

Card
labelHTTP Method
 DELETE
Card
labelDescription

Delete the specified message (id) or group of messages by given posting (messageKey).

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...

Deck of Cards
idbimBrowserMessageRead
Card
defaulttrue
labelURL / 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
labelHTTP Method
 POST
Card
labelDescription
 Mark a message (as id) or group of messages by given posting ( as messageKey) as read by browser.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...

Deck of Cards
idbimBrowserMessageUnead
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id or message_key>id>/markasunreadbrowser 

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

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

Card
labelHTTP Method
 POST
Card
labelDescription

Mark a message (as id) or group of messages by given posting ( as messageKey) as unread by browser.

Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...

Deck of Cards
idbimGetAllMessagesSentByUserToGroups
Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
Card
labelDescription

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

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",
      "messageKey":"481713d6-7dab-410c-8c8a-d65ff1d4a766",
      "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",
      "messageKey":"8757d4c6-477b-419e-b0e2-52cbb9e1b1a8",
      "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
  }
]

...