Show Source

• Array of: object NotificationUserDto
  Represents a user associated with a notification privilege (right). Includes user identification, notification privilege, name, email, and subscription status.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NotificationUserDto"
    }
}

Show Source

• privilege: string (none)
  The name of the notification right or privilege that this user is associated with.

  Example: SITE_NOTIFY
• subscription: string (none)
  'YES' if the user has subscribed to the notification indicated by 'privilege', otherwise 'NO'.

  Example: YES
• userEmailAddress: string (email)
  Email address of the user as recorded in AUTH_USERS.

  Example: sunita.smith@clinicalone.com
• userId: string (uuid)
  Hexadecimal string representing the UUID of the user authorized for this privilege.
• userName: string (none)
  User???s full name, as given_name + family_name from AUTH_USERS, separated by a space.

  Example: Alex Smith

{
    "type":"object",
    "properties":{
        "privilege":{
            "type":"string",
            "description":"The name of the notification right or privilege that this user is associated with.",
            "format":"none",
            "example":"SITE_NOTIFY"
        },
        "userId":{
            "type":"string",
            "description":"Hexadecimal string representing the UUID of the user authorized for this privilege.",
            "format":"uuid"
        },
        "userName":{
            "type":"string",
            "description":"User???s full name, as given_name + family_name from AUTH_USERS, separated by a space.",
            "format":"none",
            "example":"Alex Smith"
        },
        "userEmailAddress":{
            "type":"string",
            "description":"Email address of the user as recorded in AUTH_USERS.",
            "format":"email",
            "example":"sunita.smith@clinicalone.com"
        },
        "subscription":{
            "type":"string",
            "description":"'YES' if the user has subscribed to the notification indicated by 'privilege', otherwise 'NO'.",
            "format":"none",
            "example":"YES"
        }
    },
    "description":"Represents a user associated with a notification privilege (right). Includes user identification, notification privilege, name, email, and subscription status."
}

Show Source

• details: string
  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
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}