Page History

...

Deck of Cards

id	bimCreateMessage

Card

label	HTTP Method

POST

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string	Id of the message
userId	mandatory	string	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	mandatory	boolean	Whether the message was unread
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

Card

label	Description

Create a new message for an user.

Card

label	Request

Code Block

borderColor	Green
title	Headers
lang	xml

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

Code Block

borderColor	Red
title	JSON
lang	xml

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "userid": "c7040e44-508a-4d10-88dc-b7c7ace6c650",
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unread": false,
    "timestamp": "2013-11-15T10:55:53"
}

Card

label	Response

Code Block

borderColor	Green
title	Status
lang	xml

Status: 201 Created

Anchor

	getMessageList
	getMessageList

Get the message list of the current user

Deck of Cards

id	bimGetMemberListInfo

Card

label	HTTP Method

GET

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

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

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

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

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 278

New Version 279

Key

Get the message list of the current user