...
...
...
Messaging Service
...
Create a new message for an user
...
id | bimCreateMessage |
---|
...
default | true |
---|---|
label | URL / Resource / JSON Structure |
...
URL: https://api-stage.bimplus.net/v2/messages
Example: https://api-stage.bimplus.net/v2/messages
...
...
Name | Mandatory / Optional | Type | Description |
---|---|---|---|
id | will be ignored | string | Id of the message |
receiver | mandatory | object | receiver user object (contains id & email) |
sender | optional | object | sender user object (contains id & email) |
id | mandatory | string(guid) | id of the user |
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 |
unread | mandatory | boolean | Whether the message was unread |
additionalData | optional | string | Extra info |
correlationId | optional | guid | Id of the other related message |
Card | ||
---|---|---|
| ||
POST |
Card | ||
---|---|---|
| ||
Create a new message for an user. |
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
Get the message list of the current user
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get the message list of all the users
Deck of Cards | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Get information about a specified message
...
id | bimGetMessage |
---|
...
default | true |
---|---|
label | URL / Resource / JSON Structure |
...
URL: https://api-stage.bimplus.net/v2/messages/<message_id>
Example: https://api-stage.bimplus.net/v2/messages/<message_id>
Card | ||
---|---|---|
| ||
GET |
Card | ||
---|---|---|
| ||
Get information about a specified message |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
Card | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
|
...
Delete the specified message
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
...
Mark a message as "read"
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
...
Filter the messages (eg: Get all the unread messages from a particular user)
...
id | bimGetMessageList |
---|
Card | ||||
---|---|---|---|---|
| ||||
Resource: messages?filter=<property><operator><value>%26<property><operator><value>%26.... URL: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService Example: https://api-stage.bimplus.net/v2/messages?filter=unread=true%26receiver.email=customer@bimplus.net%26source=IssueService where "%26" is the escape character for "&" |
Card | ||
---|---|---|
| ||
GET |
Card | ||
---|---|---|
| ||
Get information about a specified message |
Card | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
...
label | Response |
---|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
Status: 200 OK
|
...
borderColor | Red |
---|---|
title | JSON |
lang | xml |
...
Anchor | ||||
---|---|---|---|---|
|
...