Jump to

• Request
• Response

V1.0

get

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

Retrieves the notification properties for a study.

Request

Path Parameters

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  62A16307A4F4479D9415FE7DB0EA0233

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request processed successfully, check the result

Body ()

Root Schema : NotificationPropertiesDto

Type: object

Collection of notification configuration properties for a study

Show Source

• notificationProperties: array notificationProperties
  List of notification properties

{
    "type":"object",
    "properties":{
        "notificationProperties":{
            "type":"array",
            "description":"List of notification properties",
            "items":{
                "$ref":"#/components/schemas/NotificationPropertyDto"
            }
        }
    },
    "description":"Collection of notification configuration properties for a study"
}

Nested Schema : notificationProperties

Type: array

List of notification properties

Show Source

• Array of: object NotificationPropertyDto
  Key-value pair to configure a single notification property

{
    "type":"array",
    "description":"List of notification properties",
    "items":{
        "$ref":"#/components/schemas/NotificationPropertyDto"
    }
}

Nested Schema : NotificationPropertyDto

Type: object

Key-value pair to configure a single notification property

Show Source

• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Allowed Values: [ "showLogo", "helpdeskInfo" ]

  Name of the notification property key

  Example: showLogo
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 4000

  Value of the notification property

  Example: For assistance, contact [e-mail] or [phone]

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Name of the notification property key",
            "example":"showLogo",
            "enum":[
                "showLogo",
                "helpdeskInfo"
            ]
        },
        "propertyValue":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Value of the notification property",
            "example":"For assistance, contact [e-mail] or [phone]"
        }
    },
    "description":"Key-value pair to configure a single notification property"
}

Examples

Select an example NotificationPropertiesDto

Back to Top