MessagingResource Resource

Messaging resource to access the inbox (list, view, mark read, delete) and send messages

POST /msg/send

Send a message to users/groups

Request Body
media type data type description
application/json MessageSendRequest (JSON) request to send messages
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /msg/send
Content-Type: application/json
Accept: application/json

                
{
  "message" : "...",
  "translations" : {
    "property1" : "...",
    "property2" : "..."
  },
  "parameters" : [ "...", "..." ],
  "toGroupId" : [ 12345, 12345 ],
  "toUserId" : [ 12345, 12345 ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "SUCCESS",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "MAINTENANCEMODE",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

GET /msg/list

List messages for the current user

Request Parameters
name type description default constraints
unread query true if only unread messages shall be shown, false for all messages (default) false boolean
Response Body
media type data type description
application/json GenericResponse (JSON) response containing the messages

Example

Request
GET /msg/list
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "CRITICAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
                
              

POST /msg/read

Set messages to be read

Request Body
media type data type description
application/json MessagesReadRequest (JSON) request containing the list of messages to be set read
Response Body
media type data type description
application/json GenericResponse (JSON) generic response

Example

Request
POST /msg/read
Content-Type: application/json
Accept: application/json

                
{
  "messages" : [ 12345, 12345 ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "messages" : [ {
    "fieldName" : "...",
    "message" : "...",
    "type" : "INFO",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  }, {
    "fieldName" : "...",
    "message" : "...",
    "type" : "NEUTRAL",
    "timestamp" : 12345,
    "image" : "...",
    "sender" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "id" : 12345
  } ],
  "responseInfo" : {
    "responseCode" : "NOTFOUND",
    "responseMessage" : "...",
    "property" : "..."
  }
}