Versions Compared

Key

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

...

Get the message list of the current user
Deck of Cards
idbimGetMemberListInfobimGetMessageList
Card
labelHTTP Method
 GET
Card
defaulttrue
labelURL / Resource / JSON Structure
 Resource: messages 

URLhttps://api.bimplus.net/v2/messages

Examplehttps://api.bimplus.net/v2/messages

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": "481713d6-7dab-410c-8c8a-d65ff1d4a766",
        "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
        "source": "ServiceName2",
        "topic": "SKETCHUP_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",
        "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
        "source": "ServiceName",
        "topic": "IFC_JOB",
        "severity": "Info",
        "returncode": "OK",
        "timestamp": "2013-11-18T14:30:53",
        "unread": true,
        "additionaldata": null,
        "correlationid": null
    }
]

Anchor
getMessage
getMessage

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

URLhttps://api.bimplus.net/v2/messages/<message_id>

Examplehttps://api.bimplus.net/v2/messages/<message_id>

Card
labelDescription
 Get information about a specified message
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",
    "userid": "b7040e44-508a-4d00-88dc-b7c7ace6c650",
    "source": "ServiceName",
    "topic": "IFC_JOB",
    "severity": "Info",
    "returncode": "OK",
    "timestamp": "2013-11-18T14:30:53",
    "unread": true,
    "additionaldata": null,
    "correlationid": null
}