Submit request for sending notifications

post

/ec-reporting-svc/rest/v1.0/notification/{notificationType}

Submits a request for sending notification on the given input, using the QueryParams parameter.
Right: ReportingPost.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request payload wrapper for notification: a map from notification field key to NotificationPayload.
Show Source
Nested Schema : notificationPayloads
Type: array
Show Source
Nested Schema : NotificationPayload
Type: object
Represents a notification detail with key and value.
Show Source
Examples

Back to Top

Response

Supported Media Types

200 Response

Notification successfully triggered.
Body ()
Root Schema : schema
Type: string
Examples

400 Response

Input validation failed; error in the payload.
Body ()
Root Schema : ValidationResult
Type: object
Show Source
Nested Schema : message
Type: object
Show Source
Examples

401 Response

Unauthorized access. The user is not allowed to send this notification.
Body ()
Root Schema : BaseResponse
Type: object
Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData.
Show Source
  • ErrorResponseData
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
  • Response status for the request; typically 'success' or 'error'.
    Example: success
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
    Example: User role is missing required permission REPORTING_VIEW. Field: userId
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
Examples

Back to Top