Jump to

• Request
• Response

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

• notificationType(required): string
  Notification Type (e.g., Created, On, Off).

  Example:

  Created

Query Parameters

• mode: string
  Mode of the study. Accepts test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Study identifier as a UUID.

  Example:

  AABB1234DD884FA1A9DC1AFDECBA1A35

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload wrapper for notification: a map from notification field key to NotificationPayload.

Show Source

• notificationPayloads: array notificationPayloads

{
    "type":"object",
    "properties":{
        "notificationPayloads":{
            "type":"array",
            "writeOnly":true,
            "items":{
                "$ref":"#/components/schemas/NotificationPayload"
            }
        }
    },
    "description":"Request payload wrapper for notification: a map from notification field key to NotificationPayload."
}

Nested Schema : notificationPayloads

Type: array

Show Source

• Array of: object NotificationPayload
  Represents a notification detail with key and value.

{
    "type":"array",
    "writeOnly":true,
    "items":{
        "$ref":"#/components/schemas/NotificationPayload"
    }
}

Nested Schema : NotificationPayload

Type: object

Represents a notification detail with key and value.

Show Source

• fieldKey: string
  Unique field identifier/key for the notification.

  Example: subjectId
• fieldName: string
  Display name for the notification field.

  Example: Subject ID
• fieldValue: string
  Value for the notification field.

  Example: SUBJ001

{
    "type":"object",
    "properties":{
        "fieldKey":{
            "type":"string",
            "description":"Unique field identifier/key for the notification.",
            "example":"subjectId"
        },
        "fieldName":{
            "type":"string",
            "description":"Display name for the notification field.",
            "example":"Subject ID"
        },
        "fieldValue":{
            "type":"string",
            "description":"Value for the notification field.",
            "example":"SUBJ001"
        }
    },
    "description":"Represents a notification detail with key and value."
}

Examples

Select an example Example notification payload

Back to Top

Response

Supported Media Types

• application/json

200 Response

Notification successfully triggered.

Body ()

Root Schema : schema

Type: string

Examples

Select an example Operation successful, no content returned.

400 Response

Input validation failed; error in the payload.

Body ()

Root Schema : ValidationResult

Type: object

Show Source

• message: object message
• valid: boolean

{
    "type":"object",
    "properties":{
        "message":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                },
                "length":{
                    "type":"integer",
                    "format":"int32",
                    "writeOnly":true
                }
            }
        },
        "valid":{
            "type":"boolean"
        }
    }
}

Nested Schema : message

Type: object

Show Source

• empty: boolean
• length: integer (int32)

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        },
        "length":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        }
    }
}

Examples

Select an example Validation failed on payload

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: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data.
• status: string
  Response status for the request; typically 'success' or 'error'.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Response status for the request; typically 'success' or 'error'.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"Generic result for all request entity types. The type returned depends on endpoint. May be ExecutionLog, list, or error data."
        },
        "ErrorResponseData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Base response object for all reporting service endpoints, providing a standard structure for status, result, and errorData."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

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.

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example User is not authorized

Back to Top