Jump to

• Request
• Response

V1.0

get

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

Returns a list of subjects with their screening numbers and site details for the specified study.

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:

  ABCDEF1234567890ABCDEF1234567890

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful retrieval of subject screening numbers.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectScreeningNumberResponseDto
  Subject screening number and related site details

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

Nested Schema : SubjectScreeningNumberResponseDto

Type: object

Subject screening number and related site details

Show Source

• id: string
  unique identifier (UUID, 32-character uppercase hexadecimal string) for a subject

  Example: 9876543210ABCDEF1234567890ABCDEF
• objectVersionNumber: integer (int32)
  Object version number

  Example: 3
• screeningNumber: string
  Unique subject Number representing the patient/participant enrolled in the study.

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

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• subjNumSiteOrgId: string
  Organization ID (UUID, 32-character uppercase hexadecimal string) for subject number at site

  Example: 40DB4EF4847849CCB24EFCCB71CDA436

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":" unique identifier  (UUID, 32-character uppercase hexadecimal string) for a subject ",
            "example":"9876543210ABCDEF1234567890ABCDEF"
        },
        "screeningNumber":{
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SCR-00123"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "objectVersionNumber":{
            "type":"integer",
            "description":"Object version number",
            "format":"int32",
            "example":3
        },
        "subjNumSiteOrgId":{
            "type":"string",
            "description":"Organization ID (UUID, 32-character uppercase hexadecimal string)  for subject number at site",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        }
    },
    "description":"Subject screening number and related site details"
}

Examples

Select an example Subject Screening Number Response

400 Response

400

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