Jump to

• Request
• Response

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/screen/validate

Pre-validates enrollment status and screening limits for one or more sites before entering Screen Candidate flow.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  ABCDEF1234567890ABCDEF1234567890

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload for pre-validating screening eligibility across one or more sites.

Show Source

• siteIds(required): array siteIds
  List of site IDs for which screening eligibility needs to be validated.

{
    "required":[
        "siteIds"
    ],
    "type":"object",
    "properties":{
        "siteIds":{
            "type":"array",
            "description":"List of site IDs for which screening eligibility needs to be validated.",
            "items":{
                "type":"string",
                "description":"List of site IDs for which screening eligibility needs to be validated."
            }
        }
    },
    "description":"Request payload for pre-validating screening eligibility across one or more sites."
}

Nested Schema : siteIds

Type: array

List of site IDs for which screening eligibility needs to be validated.

Show Source

• Array of: string
  List of site IDs for which screening eligibility needs to be validated.

{
    "type":"array",
    "description":"List of site IDs for which screening eligibility needs to be validated.",
    "items":{
        "type":"string",
        "description":"List of site IDs for which screening eligibility needs to be validated."
    }
}

Examples

Select an example Multiple site IDs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Pre-validation result returned for all requested sites.

Body ()

Root Schema : SubjectScreenPreValidationResponseDto

Type: object

Response payload for screening pre-validation across requested sites.

Show Source

• sites: array sites
  Validation results for each requested site.

{
    "type":"object",
    "properties":{
        "sites":{
            "type":"array",
            "description":"Validation results for each requested site.",
            "items":{
                "$ref":"#/components/schemas/SubjectScreenSiteValidationDto"
            }
        }
    },
    "description":"Response payload for screening pre-validation across requested sites."
}

Nested Schema : sites

Type: array

Validation results for each requested site.

Show Source

• Array of: object SubjectScreenSiteValidationDto
  Per-site pre-validation result for screening eligibility.

{
    "type":"array",
    "description":"Validation results for each requested site.",
    "items":{
        "$ref":"#/components/schemas/SubjectScreenSiteValidationDto"
    }
}

Nested Schema : SubjectScreenSiteValidationDto

Type: object

Per-site pre-validation result for screening eligibility.

Show Source

• allowed: boolean
  Whether screening is allowed for this site.

  Example: false
• reason: object SubjectScreenValidationReasonDto
  Reason details when screening is blocked for a site.
• siteId: string
  Site ID validated.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Site ID validated.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "allowed":{
            "type":"boolean",
            "description":"Whether screening is allowed for this site.",
            "example":false
        },
        "reason":{
            "$ref":"#/components/schemas/SubjectScreenValidationReasonDto"
        }
    },
    "description":"Per-site pre-validation result for screening eligibility."
}

Nested Schema : SubjectScreenValidationReasonDto

Type: object

Reason details when screening is blocked for a site.

Show Source

• code: string
  Machine-readable reason code.

  Example: COUNTRY_SCREENING_LIMIT_REACHED
• message: string
  UI-facing reason message for why screening is blocked.

  Example: Enrollment is closed or the screening limit has been reached for this country.
• scope: string
  Validation scope that triggered the block.

  Example: COUNTRY

{
    "type":"object",
    "properties":{
        "scope":{
            "type":"string",
            "description":"Validation scope that triggered the block.",
            "example":"COUNTRY"
        },
        "code":{
            "type":"string",
            "description":"Machine-readable reason code.",
            "example":"COUNTRY_SCREENING_LIMIT_REACHED"
        },
        "message":{
            "type":"string",
            "description":"UI-facing reason message for why screening is blocked.",
            "example":"Enrollment is closed or the screening limit has been reached for this country."
        }
    },
    "description":"Reason details when screening is blocked for a site."
}

400 Response

Bad request - invalid payload or site IDs.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top