Page History

...

Deck of Cards

id	bimCreateMessage

Card

default	true
label	URL / Resource / JSON Structure

Resource: messages

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

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

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string	Id of the message
receiver	mandatory	object	receiver user object (contains id & email). When 'Id' is user id, must be defined also 'email' string property with email address of the user. Email will be sent only to this address. When 'Id' is group id, email will be sent to all users which belongs to this group.
sender	optional	object	sender user object (contains id & email)
id	mandatory	string(guid)	id of the user
email	mandatory	string	email 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
unreadEmail	optional	boolean	When 'unreadEmail' is missing the default value is true. If set to true or default, the message will me marked as an email ( yet unread ), and sent via email service. If it is set as false the message will be marked as a "read" (collect) email.
unreadBrowserNotification	optional	boolean	When 'unreadBrowserNotification' is missing the default value is true. If set to true or default, the message will be marked as browser notification ( yet unread ) and send to the Bimplus portal as popup message. If it is set as false the message will be marked as a "read" (collect) browser notification.
additionalData	optional	string	Extra info
correlationId	optional	guid	Id of the other related message

Card

label	HTTP Method

POST

Card

label	Description

Create

Create a new message for an user or group of users.
When message is created as 'read' (i.e. unreadBrowserNotification or unreadEmail is set to false), such messages are not sent immediatelly but only collected in server.

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

{
    "sender": {
            "id": "1110ac3b-fa49-e540-ac2f-8caff3dd72ed"
    },
    "receiver": {
            "id": "1e2223b-fa49-e540-ac2f-8caff3dd72ed"
    },
    "source": "ServiceName",
    "topic": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unreadBrowserNotification": true
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
    "id": "4633d522-53aa-4d81-90b4-704681e0573d",
    "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": "SKETCHUP_JOB",
    "severity": "Warn",
    "returncode": "FILE_TOO_BIG",
    "unreadBrowserNotification": true,
    "timestamp": "2013-11-15T10:55:53"
}

...

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 15

New Version 16

Key