Send a Validation Message

post/notification.send

Sends a validation message (e.g., api.throwException, api.redAlert, etc.) from the validation of calculation logics in CLIC documents (Quotes, Agreements & Promotions (Contracts), Rebate Agreements, Compensation Plans) to the Notification Center (Notification API).

See the App Notifications article for more details.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
object
title
required
string
message
required
string
source
required
string
topic
required
string
actionType
required
string
status
required
string
Responses
200

A general response that contains data property with a content depending on returned objects (e.g., Product master table fields when calling the /fetch/P endpoint). Can be null.

Response Schema: application/json
object
node
string
data
object or null
status
integer
startRow
integer
endRow
integer
Request samples
application/json
{
  • "data": {
    • "notification": {
      • "title": "The Quote",
      • "message": "Hoorray it works!",
      • "source": "2147491353.Q",
      • "topic": "VALIDATION",
      • "actionType": "INFO_MESSAGE",
      • "status": "WARNING"
      }
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "data": null,
    • "status": 0,
    • "startRow": 0,
    • "endRow": 0
    }
}