Page History

Messaging Service

...

Messaging Service

...

Anchor

	createMessage
	createMessage

Create a new message for an user

Deck of Cardstab-group

iddeckId	bimCreateMessage

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: messages

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

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

JSON Structure:

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	optional	object	sender user object (contains id & email)
id	mandatory	string(guid)	id of the user
email	mandatory	string	email 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
timestamp	will be ignored	string	Creation date of the message

unread

unreadEmail

mandatory

optional

boolean

Whether the message was unread

additionalData

optional

string

Extra info

correlationId

optional

guid

Id of the other related message

Card

label	HTTP Method

POST

Card

label	Description

Create a new message for an user.

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.
unreadBrowserNotification	optional	boolean	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.
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

Tab

title	HTTP Method

POST

Tab

title	Description

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.

Tab

title

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON	lang	xml

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
      },
      "emailsource": "customer2@bimplus.netServiceName",
    },
    "source": "ServiceName",
    "topic": ""topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unreadunreadBrowserNotification": false,
    "timestamp": "2013-11-15T10:55:53"
}true
}

Tab

title

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status	lang	xml

Status: 201 Created

...

Code Block

...

title

...

JSON

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "sender": {

Get the message list of the current user

Deck of Cards

id	bimGetCurrentMessageList

Card

default	true
label	URL / 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

label	HTTP Method

GET

Card

label	Description

Gets the message list of the current user

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "id": "481713d61110ac3b-7dabfa49-410ce540-8c8aac2f-d65ff1d4a7668caff3dd72ed",
            "senderemail": {"customer1@bimplus.net"
    },
    "receiver": {
            "id": "1110ac3b1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimpluscustomer2@bimplus.net"
        },
        "receiversource": {"ServiceName",
        "topic": "SKETCHUP_JOB",
    "idseverity": "1e2223b-fa49-e540-ac2f-8caff3dd72edWarn",
            "emailreturncode": "customer2@bimplus.net"FILE_TOO_BIG",
        },
        "source"unreadBrowserNotification": "ServiceName2"true,
        "topictimestamp": "2013-11-15T10:55:53"
}

Anchor

	getMessageList
	getMessageList

Get the message list of the current user

Tab Group

deckId	bimGetCurrentMessageList

Tab

default	true
title	URL / 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

Tab

title	HTTP Method

GET

Tab

title	Description

Gets the message list of the current user

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

title	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-d65ff1d4a766SKETCHUP_JOB",
        "severity": "Info",
        "returncode": "FILE_TOO_BIG",
        "timestamp": "2013-11-18T14:55:22",
        "unread": 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": "ServiceNameServiceName2",
        "topic": "IFCSKETCHUP_JOB",
        "severity": "Info",
        "returncode": "OKFILE_TOO_BIG",
        "timestamp": "2013-11-18T14:3055:5322",
        "unreadunreadBrowserNotification": false,
        "unreadEmail": truefalse,
        "additionaldata": null,
        "correlationid": null
    }
]

...

Get the message list of all the users

Deck of Cards

id	bimGetMessageListOfAll

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets the message list of the current user

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
title	JSON
lang	xml

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

Anchor

	getMessage
	getMessage

Get information about a specified message

Tab Group

deckId	bimGetMessage

Tab

default	true
title	URL / 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>

Tab

title	HTTP Method

GET

Tab

title	Description

Get information about a specified message

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

title	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
    "id": "93c29c5d-1391-4ae8-8876-ef9815e60f7d-8876-ef9815e60f7d",
        "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer1@bimplus.net"
        },
        "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed",
    "sender": {
            "emailid": "customer3@bimplus.net"
   1110ac3b-fa49-e540-ac2f-8caff3dd72ed",
     },
        "sourceemail": "ServiceNamecustomer1@bimplus.net",
    },
    "topicreceiver": "IFC_JOB",{
            "severityid": "Info1e2223b-fa49-e540-ac2f-8caff3dd72ed",
            "returncodeemail": "OKcustomer2@bimplus.net",
    },
    "timestampsource": "2013-11-18T14:30:53ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "unreadreturncode": true"OK",
    "timestamp": "2013-11-18T14:30:53",
    "additionaldataunreadBrowserNotification": nulltrue,
    "unreadEmail": false,
    "correlationidadditionaldata": null,
    }
]"correlationid": null
}

Anchor

	getMessageputDashboardMessage	getMessage

Get information about a specified message

	putDashboardMessage

Modify contents of the dashboard messages

Tab Group

deckId	bimModifyDashboardMessage

Tab

Deck of Cards

id	bimGetMessage

Card

default	true
labeltitle	URL / 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

label	HTTP Method

GET

Card

label	Description

Get information about a specified message

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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	optional	string
pictureLink	optional	string
messageLink	optional	string

Tab

title	HTTP Method

PUT

Tab

title	Description

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

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON
lang	xml

{
    "idadditionalData": "93c29c5d-1391-4ae8-8876-ef9815e60f7d",{
    "sendertitle": {
    "Anothermessage",
        "idcontent": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed"Loremipsumdolorsitamet,consetetursadipscingelitr",
            "email": "customer1@bimplus.net"
    }"imageBase64":null,
    "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
}

...

pictureLink":"http://blog.bimplus.net/wp-content/uploads/2014/08/bim-manager-300x222.png",
    "messageLink":""
  }
}

Tab

title	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	deleteMessage
	deleteMessage

Delete the specified message

Tab Group

deckId	bimDeleteMessage

Tab

title
default	true

...

Delete the specified message

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>

Cardtab

labeltitle	HTTP Method

DELETE

Cardtab

labeltitle	Description

Delete

Delete the specified message or group of messages by given posting.

Cardtab

labeltitle	Request

Code Block

lang

borderColor	Green
lang	xml
title	Headers	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Cardtab

labeltitle	Response

Code Block

lang

borderColor	Green
lang	xml
title	Status	xml

Status: 200 OK

Anchor

...

browserMessageRead

...

browserMessageRead

Mark a browser message as "read"

Deck of Cardstab-group

iddeckId	bimMessageReadbimBrowserMessageRead

Cardtab

default	true
labeltitle	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasread markasreadbrowser

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

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

Cardtab

labeltitle	HTTP Method

POST

Cardtab

labeltitle	Description

Mark a message as read.or group of messages by given posting as read by browser.

Tab

title

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Anchor

...

browserMessageUnread

...

Filter the messages (eg: Get all the unread messages from a particular user)

browserMessageUnread

Mark a browser message as "unread"

Tab Group

deckId	bimBrowserMessageUnead

Tab

Deck of Cards

id	bimGetMessageList

Card

default	true
labeltitle	URL / Resource / JSON Structure

Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26..../<message_id>/markasunreadbrowser

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

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>/markasunreadbrowser

Tab

title

Card

label	HTTP Method

GET POST

Cardtab

labeltitle	Description

Get information about

Mark a

specified message

message or group of messages by given posting as unread by browser.

Tab

title

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers
lang	xml

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Cardtab

labeltitle	Response

Code Block

borderColor	Green
lang	xml
title	Status
lang	xml

Status: 200 OK

Anchor
emailMessageUnread
emailMessageUnread

Mark an email message as "unread"

Tab Group

deckId	bimEmailMessageUnread

Tab

default	true
title	URL / Resource / JSON Structure

Resource: messages/<message_id>/markasunreademail

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

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

Tab

title	HTTP Method

POST

Tab

title	Description

Mark an email message as unread.

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

title	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Anchor

	messageFilter
	messageFilter

Filter the messages (eg: Get all the unread messages from a particular user)

Tab Group

deckId	bimGetMessageList

Tab

default	true
title	URL / 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 "&"

Tab

title	HTTP Method

GET

Tab

title	Description

Get information about a specified message

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

title	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[
    {

Code Block

borderColor	Red
title	JSON
lang	xml

[
    {
        "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"
        },
        "source": "IssueService",
        "topic": "ISSUE_DELETED",
        "severity": "Info",
        "returnCode": "ISSUE_DELETED",
        "timestampid": "2014-05-09T09:54:1744ad058b-1f76-4343-bafa-031eb462215c",
        "unreadreceiver": true,{
          "correlationId": null
    },
    {
        "id": "0a4c8eab-26af-49ce-9191-049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "topic": "ISSUE_UPDATEDDELETED",
        "severity": "Info",
        "returnCode": "ISSUE_UPDATEDDELETED",
        "timestamp": "2014-0405-08T0809T09:54:4117",
        "unreadunreadBrowserNotification": true,
        "correlationIdunreadEmail": false,
      "de96f4ae-79fd-4d83-99e9-07cec7a80906"  "correlationId": null
    },
    {
        "id": "ffd500960a4c8eab-fb8226af-402949ce-8d499191-06a04e31f02a049a141ba762",
        "receiver": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "email": "customer@bimplus.net"
        },
        "sender": {
            "id": "71e0ac3b-fa49-e540-ac2f-8caff3dd72ed",
            "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
    }
]email": "testuser1@bimplus.net"
        },
        "source": "IssueService",
        "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

Tab Group

deckId	bimGetAllMessagesSentByUserToUsers

Tab

default	true
title	URL / 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

Tab

title	HTTP Method

GET

Tab

title	Description

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

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

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

Tab Group

deckId	bimGetAllMessagesSentByUserToGroups

Tab

default	true
title	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

Tab

title	HTTP Method

GET

Tab

title	Description

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

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

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

Tab Group

deckId	bimGetAllMessagingGroups

Tab

default	true
title	URL / Resource / JSON Structure

Resource: systemgroups

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

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

Tab

title	HTTP Method

GET

Tab

title	Description

Gets all existing messaging groups.

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

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

Anchor

	getMessagingGroupDetails
	getMessagingGroupDetails

Get the messaging group details

Tab Group

deckId	bimGetMessagingGroupDetails

Tab

default	true
title	URL / 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

Tab

title	HTTP Method

GET

Tab

title	Description

Get details of a specified messaging group. Description of returned json in Create a new messaging group.

Tab

title	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Tab

title	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 4

New Version Current

Key

Messaging Service

Create a new message for an user

Get the message list of the current user

Get the message list of the current user

Get the message list of all the users

Get information about a specified message

Get information about a specified message

Modify contents of the dashboard messages

Delete the specified message

Delete the specified message

Anchor

browserMessageRead

browserMessageRead

Mark a browser message as "read"

Anchor

browserMessageUnread

Filter the messages (eg: Get all the unread messages from a particular user)

browserMessageUnread

Mark a browser message as "unread"

Anchor
emailMessageUnread
emailMessageUnread

Mark an email message as "unread"

Filter the messages (eg: Get all the unread messages from a particular user)

Get all messages sent by given user to all single users

Get all messages sent by given user to all groups

Get all messaging groups

Get the messaging group details

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 4

New Version Current

Key

Messaging Service

Create a new message for an user

Get the message list of the current user

Get the message list of the current user

Get the message list of all the users

Get information about a specified message

Get information about a specified message

Modify contents of the dashboard messages

Delete the specified message

Delete the specified message

Anchor

browserMessageRead

browserMessageRead

Mark a browser message as "read"

Anchor

browserMessageUnread

Filter the messages (eg: Get all the unread messages from a particular user)

browserMessageUnread

Mark a browser message as "unread"

AnchoremailMessageUnreademailMessageUnread

Mark an email message as "unread"

Filter the messages (eg: Get all the unread messages from a particular user)

Get all messages sent by given user to all single users

Get all messages sent by given user to all groups

Get all messaging groups

Get the messaging group details

Anchor
emailMessageUnread
emailMessageUnread