Versions Compared

Old Version 31

changes.mady.by.user Eduard Mrazek

Saved on

compared with

New Version 32

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>id or message_key>/updatedashboardadditionaldata

URL: https://api-stage.bimplus.net/v2/messages/<message_id or message_id>key>/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 message
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
Code Block
titleJSON
{
    "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"
}

...