Versions Compared

Old Version 4

changes.mady.by.user Jayaraj Purushothaman

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

...

Messaging Service

...

Anchor
createMessage
createMessage

...

Deck of Cards
idbimCreateMessage
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages 

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

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

JSON Structure: 

sender

Name

Mandatory / Optional

Type

Description

id

will be ignored

string

Id of the message

receiver

mandatory

object

receiver user object (contains id & email)

.
When 'Id' is user id, must be defined also 'email' string property with email address of the user. Email will be sent only to this address.
When 'Id' is group id, email will be sent to all users which belongs to this group.

sender
optionalobjectsender user object (contains id & email)
idmandatorystring(guid)id of the user
emailmandatorystringemail id of the user

source

mandatory

string

Source of the message (eg: Import Service)

topic

mandatory

string

Topic of the message

severity

mandatory

object

Severity can be Info, Warning, Error

returnCode

mandatory

string

Readable return code

timestampwill be ignoredstringCreation date of the message
unread
unreadEmail
mandatory
optionalboolean
Whether the message was unread
additionalDataoptionalstringExtra info
correlationIdoptionalguidId of the other related message

When 'unreadEmail' is missing the default value is true.
If set to true or default, the message will me marked as an email ( yet unread ), and sent via email service.
If it is set as false the message will be marked as a "read" (collect) email.

unreadBrowserNotificationoptionalboolean

When 'unreadBrowserNotification' is missing the default value is true.
If set to true or default, the message will be marked as browser notification ( yet unread ) and send to the Bimplus portal as popup message.
If it is set as false the message will be marked as a "read" (collect) browser notification.

additionalDataoptionalstringExtra info
correlationIdoptionalguidId of the other related message
Card
label
Card
labelHTTP Method
 POST
Card
labelDescription
 Create

Create a new message for an user or group of users.
When message is created as 'read' (i.e. unreadBrowserNotification or unreadEmail is set to false), such messages are not sent immediatelly but only collected in server.

Card
labelRequest
Code Block
lang
borderColorGreen
langxml
titleHeadersxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Code Block
borderColorRed
langxml
titleJSON
langxml
{
    "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",
    "unreadunreadBrowserNotification": false,
    "timestamp": "2013-11-15T10:55:53"true
}
Card
labelResponse
Code Block
borderColorGreen
titlelangStatusxml
langtitlexmlStatus
Status: 201 Created

...

Code Block

...

title

...

Get the message list of the current user
JSON
{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
Deck of Cards
idbimGetCurrentMessageList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: user/<user_id>/messages 

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the message list of the current user
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {
        "id": "481713d61e2223b-7dabfa49-410ce540-8c8aac2f-d65ff1d4a7668caff3dd72ed",
            "senderemail": {"customer2@bimplus.net"
        },
    "idsource": "1110ac3b-fa49-e540-ac2f-8caff3dd72edServiceName",
    "topic": "SKETCHUP_JOB",
       "emailseverity": "customer1@bimplus.netWarn",
        }"returncode": "FILE_TOO_BIG",
        "receiverunreadBrowserNotification": {true,
            "id"timestamp": "1e2223b2013-11-15T10:55:53"
}

Anchor
getMessageList
getMessageList

Get the message list of the current user
Deck of Cards
idbimGetCurrentMessageList
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: user/<user_id>/messages 

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the message list of the current user
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
[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",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d481713d6-13917dab-4ae8410c-88768c8a-ef9815e60f7dd65ff1d4a766",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer2@bimplus.net"
        },
        "source": "ServiceNameServiceName2",
        "topic": "IFCSKETCHUP_JOB",
        "severity": "Info",
        "returncode": "OKFILE_TOO_BIG",
        "timestamp": "2013-11-18T14:30:53"55:22",
        "unreadBrowserNotification": false,
        "unreadunreadEmail": truefalse,
        "additionaldata": null,
        "correlationid": null
    }
]

...

Get the message list of all the users
Deck of Cards
idbimGetMessageListOfAll
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages 

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Gets the message list of the current user
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
[
    {,
    {
        "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        "id": "481713d6-7dab-410c-8c8a-d65ff1d4a766"},
        "senderreceiver": {
            "id": "1110ac3b1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimpluscustomer2@bimplus.net"
        },
        "receiversource": {"ServiceName",
            "idtopic": "1e2223b-fa49-e540-ac2f-8caff3dd72edIFC_JOB",
            "emailseverity": "customer2@bimplus.netInfo",
        }"returncode": "OK",
        "sourcetimestamp": "ServiceName22013-11-18T14:30:53",
        "topicunreadBrowserNotification": "SKETCHUP_JOB"true,
        "severityunreadEmail": "Info"false,
        "returncodeadditionaldata": "FILE_TOO_BIG"null,
        "timestamp": "2013-11-18T14:55:22",
        "unread": false,
        "additionaldata": null,
        "correlationid": null
    },
    {
        "id": "93c29c5d-1391-4ae8-8876-
]


Anchor
getMessage
getMessage

Get information about a specified message
Deck of Cards
idbimGetMessage
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages 

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

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


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": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver"receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer3@bimpluscustomer2@bimplus.net"
        },
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unreadunreadBrowserNotification": true,
    "unreadEmail": false,
    "additionaldata": null,
        "correlationid": null
    }
]


Anchor
getMessageputDashboardMessagegetMessage

...

putDashboardMessage

Modify contents of the dashboard messages
Deck of Cards
idbimGetMessagebimModifyDashboardMessage
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages messages/<message_id>/updatedashboardadditionaldata

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

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

Card
labelHTTP Method
 GET
Card
labelDescription
 Get information about a specified message
Card
labelRequest
Code Block
borderColorGreen
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

/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 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
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
Status: 200 OK
Code Block
borderColorRed
titleJSON
langxml
{
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",
    "sendercontent": {"Loremipsumdolorsitamet,consetetursadipscingelitr",
    "imageBase64":null,
        "idpictureLink": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed"http://blog.bimplus.net/wp-content/uploads/2014/08/bim-manager-300x222.png",
            "email"messageLink": ""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",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}

...


}
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK


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

...

Delete the specified message
Deck of Cards
idbimDeleteMessage
Card
defaulttrue
labelURL / 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
labelHTTP Method
 DELETE POST
Card
labelDescription
 Delete the specified message Mark a message or group of messages by given posting as read by browser.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaderslangxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
langxml
Status: 200 OK
Anchor

...

browserMessageUnread

...

browserMessageUnread
Mark a browser message as "

...

unread"
Deck of Cards
idbimMessageReadbimBrowserMessageUnead
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages/<message_id>/markasread markasunreadbrowser 

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

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

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
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
titleStatus
langxml
titleStatus
Status: 200 OK
Anchor

...

emailMessageUnread

...

emailMessageUnread
Mark an email message as "unread"
Deck of Cards
idbimGetMessageListbimEmailMessageUnread
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26..../<message_id>/markasunreademail 

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

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

/<message_id>/markasunreademail

Card
labelHTTP Method
 GET POST
Card
labelDescription
 Get information about a specified message Mark an email message as unread.
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
langxml
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
code
Code Block
borderColorGreen
langxml
titleStatus
langxml
Status: 200 OK

Anchor

...

messageFilter
messageFilter

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
[
    {
Red
titleJSON
langxml
[
    {
        "id": "44ad058b-1f76-4343-bafa-031eb462215c",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "sourceid": "IssueService44ad058b-1f76-4343-bafa-031eb462215c",
        "topicreceiver": "ISSUE_DELETED",
{
          "severity  "id": "Info71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
        "returnCode": "ISSUE_DELETED",
        "timestampemail": "2014-05-09T09:54:17",customer@bimplus.net"
        "unread": true},
        "correlationIdsender": null
    },{
    {
        "id": "0a4c8eab71e0ac3b-26affa49-49cee540-9191ac2f-049a141ba7628caff3dd72ed",
            "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_UPDATED",{
        "severityid": "Info0a4c8eab-26af-49ce-9191-049a141ba762",
        "returnCodereceiver": "ISSUE_UPDATED",{
            "timestampid": "201471e0ac3b-04-08T08:54:41fa49-e540-ac2f-8caff3dd72ed",
        "unread": true,
        "correlationIdemail": "de96f4ae-79fd-4d83-99e9-07cec7a80906customer@bimplus.net"
    },
    {
        "id": "ffd50096-fb82-4029-8d49-06a04e31f02a"},
        "receiversender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplustestuser1@bimplus.net"
        },
        "sendersource": {"IssueService",
            "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",
        "unread": true,       
        "correlationId": null
    }
]"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
    }
]

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

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":""
  },
  "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
    "6be10633-5950-319f-eae0-12dec2c04219",
    "3b638075-24cd-cb2b-5464-fa955d2bd1e0"
  ]
}