Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Messaging Service

...

Anchor
createMessage
createMessage

...

Deck of Cards
idbimGetAllMessagesSentByUserToGroups
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: user/<user_id>/messages/groupsent

URLhttps://api-stage.bimplus.net/v2/user/<user_id>/messages/groupsent

Examplehttps://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"
    },
    "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
getAllMessagingGroups
getAllMessagingGroups

...

Deck of Cards
idbimGetMessagingGroupDetails
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups/<messaginggroup_id>

URLhttps://api-stage.bimplus.net/v2/ systemgroups/<messaginggroup_id>

Examplehttps://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"
  ]
}

...

Delete the messaging group
Deck of Cards
idbimDeleteMessagingGroup
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: systemgroups/<messaginggroup_id>

URLhttps://api-stage.bimplus.net/v2/ systemgroups/<messaginggroup_id>

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

Card
labelHTTP Method
 DELETE
Card
labelDescription
 Deletes a specified 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