Versions Compared

Key

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

...

...

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

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

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

...

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

 

...

Examplehttps://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
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

...

labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK

...

borderColorRed
langxml
titleJSON

...

Anchor
getMessage
getMessage

...