Page History

...

Deck of Cards

id	bimGetAllMessagesSentByUserToGroups

Card

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

Card

label	HTTP Method

GET

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	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,
    "groupId":"0c82421d-1ca9-4b6a-b6bb-eb5ddcb79760"
  },
  {
    "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,
    "groupId":"0c82421d-1ca9-4b6a-b6bb-eb5ddcb79760"
  }
]

Anchor

	createMessagingGroup
	createMessagingGroup

Create a new messaging group

Deck of Cards

id	bimCreateMessagingGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/systemgroups

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

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

JSON Structure:

Name

Mandatory / Optional

Type

Description

systemGroup

mandatory

object

The object contains information about group to be created where :

Id is optional property as string(guid)
name mandatory property as string. Must be unique name
description option property as string

usersIdList

mandatory

list of string(guid)

List of user id’s belonging to the group. User list requires valid user identifiers.

Card

label	HTTP Method

POST

Card

label	Description

Create a new messaging group with a members.The content json object contains information about group (id, name, description) and list of user id’s belonging to the group. User list requires valid user identifiers.
Hint : Before post is recommended to check existence of a group with wanted name because creation of groups with existing name is forbiden.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "systemGroup":{
    "name":"Bimplusdevelopers",
    "description":"GroupofBimplusdevelopers"
  },
  "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
    "6be10633-5950-319f-eae0-12dec2c04219",
    "2e798f29-4b71-15ee-90eb-18592bc18317"
  ]
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "systemGroup":{
    "id":"df0f426c-b972-4c16-9839-c77ac5930bcc",
    "name":"Bimplusdevelopers",
    "description":"GroupofBimplusdevelopers"
  },
  "usersIdList":["61c9c325-52a2-21b5-47b6-0a06e7152ff9",
    "6be10633-5950-319f-eae0-12dec2c04219",
    "2e798f29-4b71-15ee-90eb-18592bc18317"
  ]
}

Anchor

	getAllMessagingGroups
	getAllMessagingGroups

Get all messaging groups

Deck of Cards

id	bimGetAllMessagingGroups

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/systemgroups

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

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

Card

label	HTTP Method

GET

Card

label	Description

Gets all existing messaging groups

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	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

Deck of Cards

id	bimGetMessagingGroupDetails

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/systemgroups/<messaginggroup_id>

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

Example: https://api-stage.bimplus.net/v2/messages/systemgroups/242fab5a-fce6-4413-900b-5f5b6ca2a414

Card

label	HTTP Method

GET

Card

label	Description

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

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

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

Anchor

	deleteMessagingGroup
	deleteMessagingGroup

Delete the messaging group

Deck of Cards

id	bimDeleteMessagingGroup

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages/systemgroups/<messaginggroup_id>

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

Example: https://api-stage.bimplus.net/v2/messages/systemgroups/242fab5a-fce6-4413-900b-5f5b6ca2a414

Card

label	HTTP Method

DELETE

Card

label	Description

Deletes required messaging group.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

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

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 26

New Version 27

Key

Create a new messaging group

Get all messaging groups

Get the messaging group details

Delete the messaging group