Jump to

• Request
• Response

V1

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/selectionStatus/{siteId}

Retrieves the SDV subject selection status for the provided site. Returns current and previous selection information for all subjects under the site.

Request

Path Parameters

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

  Example:

  test

• siteId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example:

  FEDCBA1234567890FEDCBA1234567890

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

  Example:

  ABCDEF1234567890ABCDEF1234567890

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of SDV subjects for the given siteId with their selection status and previous subject number.

Body ()

Root Schema : SubjectSDVDtoList

Type: object

List of SDV subject selection objects with the previously selected subject number.

Show Source

• prevSelectedSubjectNumber: string
  Previously selected subject number for reference.

  Example: SUBJ-0001
• subjectsList: array subjectsList
  List of SDV subject objects returned as selection status result.

{
    "type":"object",
    "properties":{
        "prevSelectedSubjectNumber":{
            "type":"string",
            "description":"Previously selected subject number for reference.",
            "example":"SUBJ-0001"
        },
        "subjectsList":{
            "type":"array",
            "description":"List of SDV subject objects returned as selection status result.",
            "items":{
                "$ref":"#/components/schemas/SubjectSDVDto"
            }
        }
    },
    "description":"List of SDV subject selection objects with the previously selected subject number."
}

Nested Schema : subjectsList

Type: array

List of SDV subject objects returned as selection status result.

Show Source

• Array of: object SubjectSDVDto
  Basic SDV subject selection information.

{
    "type":"array",
    "description":"List of SDV subject objects returned as selection status result.",
    "items":{
        "$ref":"#/components/schemas/SubjectSDVDto"
    }
}

Nested Schema : SubjectSDVDto

Type: object

Basic SDV subject selection information.

Show Source

• id: string
  Unique identifier for the SDV subject (UUID, 32-character uppercase hexadecimal string)

  Example: 22223333444455556666777788889999
• sdvSelectionStatus: string
  Source data verification selection status for the subject it can be NOT_SELECTED, INITIALCOUNT_SELECTED, POST_INITIALCOUNT_SELECTED.

  Example: NOT_SELECTED
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

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

  Example: ABCDEF1234567890ABCDEF1234567890
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  Unique subject Number representing the patient/participant enrolled in the study.

  Example: SUBJ-0204

{
    "required":[
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for the SDV subject (UUID, 32-character uppercase hexadecimal string)",
            "example":"22223333444455556666777788889999"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0204"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"FEDCBA1234567890FEDCBA1234567890"
        },
        "sdvSelectionStatus":{
            "type":"string",
            "description":"Source data verification selection status for the subject it can be NOT_SELECTED, INITIALCOUNT_SELECTED, POST_INITIALCOUNT_SELECTED.",
            "example":"NOT_SELECTED"
        }
    },
    "description":"Basic SDV subject selection information."
}

Examples

Select an example Example: SDV subject selection status 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