Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings

Fetch all persisted enrollment settings for a given study and mode. Returns a response containing an array of EnrollmentSetting objects, each representing the settings for a group.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

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

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success: Returns an array of persisted enrollment settings for the specified study and mode.

Body ()

Root Schema : EnrollmentSetting

Type: object

Represents the persisted enrollment setting for a study group.

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment regarding the last change made to the entity.

  Example: Imported via migration tool.
• description: string
  Brief description of the enrollment setting.

  Example: Phase 1 - First cohort group
• enableSetting: boolean
  Indicates if the enrollment setting is enabled.

  Example: true
• groupTitle: string
  Title of the group receiving this setting.

  Example: Cohort A
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for the enrollment setting.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• notificationLimit: integer (int32)
  Notification threshold for approaching subject limit.

  Example: 80
• operationType: string
  Minimum Length: 1

  Maximum Length: 16

  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: REMOVED
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the entity creation or latest modification.

  Example: Initial import.
• subjectLimit: integer (int32)
  Maximum number of subjects allowed in this group.

  Example: 100
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the enrollment setting.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "groupTitle":{
            "type":"string",
            "description":"Title of the group receiving this setting.",
            "example":"Cohort A"
        },
        "subjectLimit":{
            "type":"integer",
            "description":"Maximum number of subjects allowed in this group.",
            "format":"int32",
            "example":100
        },
        "notificationLimit":{
            "type":"integer",
            "description":"Notification threshold for approaching subject limit.",
            "format":"int32",
            "example":80
        },
        "description":{
            "type":"string",
            "description":"Brief description of the enrollment setting.",
            "example":"Phase 1 - First cohort group"
        },
        "enableSetting":{
            "type":"boolean",
            "description":"Indicates if the enrollment setting is enabled.",
            "example":true
        }
    },
    "description":"Represents the persisted enrollment setting for a study group."
}

Examples

Select an example Enrollment Settings Response Result

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• 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":"object",
            "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."
}

Nested Schema : result

Type: object

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

Back to Top