1. REST API for Clinical One Platform
  2. Tasks
  3. Notifications
  4. Broadcast
  5. View notification broadcast message description

V1.0

get

/ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast

Gets list of notification based on query parameter for user in specific order

Request

Path Parameters
Query Parameters
  • Filter by approval flag (Y or N).
    Allowed Values: [ "Y", "N" ]
    Example:
    N
  • Functional category of the notification. Some examples: Shipment Failure, Site state Change, Report Generation etc.
    Example:
    Report Generation
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.
    Example:
    6153170BDE5244A0BB3DF169C4168483
  • Maximum number of records to display per page.
    Example:
    50
  • Filter by message subject (full or partial match, depending on implementation).
    Example:
    S4-Copy | Subject Visits (Unblinded) Report is ready in Clinical One
  • An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.
    Example:
    0
  • Get list of notification in a specific order. Accepted values: a-z [Sort by notificationDateTime in ascending order & messageSubject in descending order], z-a [Sort by notificationDateTime & messageSubject in descending order], recent [Sort by entityType & messageSubject in descending order], type [Sort by notificationDateTime in descending order], read [Ordering not enabled], unread [Ordering not enabled]
    Allowed Values: [ "a-z", "z-a", "recent", "type", "read", "unread" ]
    Example:
    recent
  • Filter by subscription status. Accepted values: YES or NO.
    Allowed Values: [ "YES", "NO" ]
    Example:
    YES
  • Filter by user email address.
    Example:
    user@example.com
  • Filter by user name.
    Example:
    system ClinicalOne

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Request processed successfully, check the result
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : NotificationsDetailResponse
Type: object
Aggregated notification broadcast details combined with notification log metadata
Show Source
Nested Schema : NotificationsBroadcast
Type: object
Notification broadcast record representing a user-targeted notification with audit and delivery metadata
Show Source
Examples

400 Response

Error in request, check the request
Body ()
Root Schema : NotificationResponse
Type: object
Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails.
Show Source
  • ErrorResponseData
    Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
  • result
    Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
  • Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.
    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
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • 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
Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
Nested Schema : details
Type: object
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
Examples

Back to Top