Jump to

• Request
• Response

List users to send notifications to

get

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

Gets a list of the users who have the right associated with receiving notifications.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• rightname(required): string
  Name of the right associated with receiving notifications. Valid values are taken from authorization service.
• studyId(required): string
  ID of the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object NotificationUserDto

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

Nested Schema : NotificationUserDto

Type: object

Show Source

• privilege: string
• subscription: string
• userEmailAddress: string
• userId: string
• userName: string

{
    "type":"object",
    "properties":{
        "privilege":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "userEmailAddress":{
            "type":"string"
        },
        "subscription":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top