Versions Compared

Old Version 22

changes.mady.by.user Ivan Pavlovcik

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.

...

Messaging Service

...

Anchor
createMessage
createMessage

...


Anchor
putDashboardMessage
putDashboardMessage

Modify

...

contents of the dashboard

...

messages
Deck of Cards
idbimModifyDashboardMessage
Card
defaulttrue
labelURL / 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
optionalstring
pictureLink
optionalstring
messageLink
optionalstring
Card
labelHTTP Method
 PUT
Card
labelDescription
 Update

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

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

...


 Anchor
deleteMessage
deleteMessage
Delete the specified message
 Deck of Cards
idbimDeleteMessage
 Card
defaulttrue
labelURL / 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
labelHTTP Method
 DELETE
 Card
labelDescription
Delete the specified message or group of messages by given posting.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


 Anchor
browserMessageRead
browserMessageRead
Mark a browser message as "read"
 Deck of Cards
idbimBrowserMessageRead
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_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
labelHTTP Method
 POST
 Card
labelDescription
 Mark a message or group of messages by given posting as read by browser.
 Card
labelRequest
 Code Block
borderColor
...
Delete the specified message
 Deck of Cards
idbimDeleteMessage
 Card
defaulttrue
labelURL / 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
labelHTTP Method
 DELETE
 Card
labelDescription
 Delete the specified message.
 Card
labelRequest
 Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

 Card
labelResponse
 Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

 Anchor
...
browserMessageUnread
...
browserMessageUnread
Mark a browser message as "
...
unread"
 Deck of Cards
idbimBrowserMessageReadbimBrowserMessageUnead
 Card
defaulttrue
labelURL / 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
labelHTTP Method
 POST
 Card
labelDescription
 Mark 
Mark a message 
 as read 
or group of messages by given posting 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

 Anchor
...
emailMessageUnread
...
emailMessageUnread
Mark 
...
an email message as "unread"
 Deck of Cards
idbimBrowserMessageUneadbimEmailMessageUnread
 Card
defaulttrue
labelURL / 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
labelHTTP Method
 POST
 Card
labelDescription
 Mark a an email message 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

 Anchor
...
messageFilter
...
messageFilter
Filter the messages (eg: Get all the unread messages from a particular user)
...
 Deck of Cards
idbimEmailMessageUnreadbimGetMessageList
 Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
 Card
labelHTTP Method
 POST
 Card
labelDescription
 Mark an email message as unread. Get information about a specified message
 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
...
Red
langxml
titleJSON
[
    {
        "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
idbimGetMessageList
 Card
defaulttrue
labelURL / 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
labelHTTP Method
 GET
 Card
labelDescription
 Get information about a specified message
 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": "44ad058b71e0ac3b-1f76fa49-4343e540-bafaac2f-031eb462215c8caff3dd72ed",
            "receiveremail": {"testuser1@bimplus.net"
        },
        "idsource": "71e0ac3b-fa49-e540-ac2f-8caff3dd72edIssueService",
            "emailtopic": "customer@bimplus.net"ISSUE_DELETED",
        } "severity": "Info",
        "senderreturnCode": {"ISSUE_DELETED",
            "idtimestamp": "71e0ac3b2014-fa49-e540-ac2f-8caff3dd72ed05-09T09:54:17",
            "emailunreadBrowserNotification": "testuser1@bimplus.net"true,
        },
"unreadEmail": false,
        "sourcecorrelationId": "IssueService",null
    },
    "topic": "ISSUE_DELETED",{
        "severityid": "Info0a4c8eab-26af-49ce-9191-049a141ba762",
        "returnCodereceiver": "ISSUE_DELETED",
{
            "timestampid": "2014-05-09T09:54:1771e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "unreadBrowserNotification": true,
        "unreadEmail": false,
        "correlationId": null
"email": "customer@bimplus.net"
        },
    {
        "idsender": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplustestuser1@bimplus.net"
        },
        "sendersource": {"IssueService",
            "idtopic": "71e0ac3b-fa49-e540-ac2f-8caff3dd72edISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED",
        "emailtimestamp": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATED"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
    }
]
 Anchor
getAllMessagesSentByUserToUsers
getAllMessagesSentByUserToUsers
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
URL: https://api-stage.bimplus.net/v2/user/<user_id>/messages/sent
Example: https://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
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"
    },
    "receiver":{
      "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
  },
  {
    "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
getAllMessagesSentByUserToGroups
getAllMessagesSentByUserToGroups
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
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",
      "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":"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
  }
]

 Anchor
getAllMessagingGroups
getAllMessagingGroups
Get all messaging groups
 Deck of Cards
idbimGetAllMessagingGroups
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups 
URL: https://api-stage.bimplus.net/v2/systemgroups
Example: https://api-stage.bimplus.net/v2/systemgroups
 Card
labelHTTP Method
 GET
 Card
labelDescription
 Gets all existing messaging 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
[{
    "systemGroup":{
      "id":"9c3c8a6c-67b5-406f-a44c-0dca6eb3c031",
        "timestampname": "2014-04-08T08:54:41"Users from Munich",
        "unreadBrowserNotificationdescription":"Group false,
of users from Munich     "unreadEmail": false,area"
    },
    "correlationIdusersIdList": ["de96f4ae6ae90098-79fd5b01-4d834141-99e98ef5-07cec7a809060079ae6c1c04",
    },
    {"9d32f46b-157f-dfee-a5d7-0162543dc304",
        "id": "ffd50096-fb82-4029-8d49-06a04e31f02a","a33e89a2-b5fc-408a-b4ec-01fb593e2b1d"
    ]
  },
  "receiver": {
    "systemGroup":{
        "id": "71e0ac3b242fab5a-fa49fce6-e5404413-ac2f900b-8caff3dd72ed5f5b6ca2a414",
      "name":"Users from Paris",
      "emaildescription": "customer@bimplus.net"
Group of users from Paris"
    },
    "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
     "sender": {
    "6be10633-5950-319f-eae0-12dec2c04219",
      "2e798f29-4b71-15ee-90eb-18592bc18317"
         "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]
  }
]
 Anchor
getMessagingGroupDetails
getMessagingGroupDetails
Get the messaging group details
 Deck of Cards
idbimGetMessagingGroupDetails
 Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups/<messaginggroup_id>
URL: https://api-stage.bimplus.net/v2/ systemgroups/<messaginggroup_id>
Example: https://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":{
    "id":"242fab5a-fce6-4413-900b-5f5b6ca2a414",
    "name":"Bimplusdevelopers",
    "description":""
  },
  "unreadBrowserNotificationusersIdList": false["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
        "unreadEmail": true"6be10633-5950-319f-eae0-12dec2c04219",
        "correlationId": null"3b638075-24cd-cb2b-5464-fa955d2bd1e0"
    ]
}
]