Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{siteId}/subjects

Retrieves a list of all subjects based on study ID and site ID. Rights: DataCaptureSubjectGet.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• siteId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DCSSubject
  Title: DCSSubject

  DCS Subject details.

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

Nested Schema : DCSSubject

Type: object

Title: DCSSubject

DCS Subject details.

Show Source

• codeBreak: string
  Reveals the Treatment arm of a subject and the kits dispensed along with their description.

  Example: Treatment arm B
• description: string
  Subject description.

  Example: Subject undergoing treatment for asthma.
• dob: string (date)
  Date of birth of the subject.

  Example: 2019-03-06
• enrollmentFailure: string
  Reason for enrollment failure.

  Example: Enrollment failed.
• enrollmentOverride: string
  Enrollment Override

  Example: Enrollment Override.
• gender: string
  Subject gender

  Example: Male
• id: string (uuid)
  DCS Subject ID.
• informedConsentDate: string (date)
  Informed consent date

  Example: 2019-03-06
• mhealthSubjectId: string (uuid)
  ID of the mhealth subject
• randomized: boolean
  Indicate if subject is randomized.

  Example: true
• screeningDate: string (date)
  Date of screening of the subject at the site.

  Example: 2019-03-06
• screeningFailure: string
  Reason for screening failure.

  Example: Screening failed.
• siteId: string (uuid)
  ID of the site.
• state: string
  Allowed Values: [ "New", "Active", "Screening_Initiated", "Screen_Failed", "Withdrawn", "Auto_Screen_Failed" ]

  State of the subject.

  Example: Active
• stateDate: string (date)
  Date on which the subject achieved the state mentioned.

  Example: 2019-03-06
• studyId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.5
• subjectNumber: string
  Subject number for the study.

  Example: 1-10
• subjectTransferId: string (uuid)
  ID of the subject transfer
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2018-11-23T08:43:01Z

{
    "title":"DCSSubject",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"DCS Subject ID.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2018-11-23T08:43:01Z"
        },
        "description":{
            "type":"string",
            "description":"Subject description.",
            "example":"Subject undergoing treatment for asthma."
        },
        "subjectNumber":{
            "type":"string",
            "description":"Subject number for the study.",
            "example":"1-10"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "format":"uuid"
        },
        "siteId":{
            "type":"string",
            "description":"ID of the site.",
            "format":"uuid"
        },
        "dob":{
            "type":"string",
            "description":"Date of birth of the subject.",
            "format":"date",
            "example":"2019-03-06"
        },
        "screeningDate":{
            "type":"string",
            "description":"Date of screening of the subject at the site.",
            "format":"date",
            "example":"2019-03-06"
        },
        "state":{
            "type":"string",
            "description":"State of the subject.",
            "example":"Active",
            "enum":[
                "New",
                "Active",
                "Screening_Initiated",
                "Screen_Failed",
                "Withdrawn",
                "Auto_Screen_Failed"
            ]
        },
        "stateDate":{
            "type":"string",
            "description":"Date on which the subject achieved the state mentioned.",
            "format":"date",
            "example":"2019-03-06"
        },
        "screeningFailure":{
            "type":"string",
            "description":"Reason for screening failure.",
            "example":"Screening failed."
        },
        "enrollmentFailure":{
            "type":"string",
            "description":"Reason for enrollment failure.",
            "example":"Enrollment failed."
        },
        "enrollmentOverride":{
            "type":"string",
            "description":"Enrollment Override",
            "example":"Enrollment Override."
        },
        "informedConsentDate":{
            "type":"string",
            "description":"Informed consent date",
            "format":"date",
            "example":"2019-03-06"
        },
        "gender":{
            "type":"string",
            "description":"Subject gender",
            "example":"Male"
        },
        "subjectTransferId":{
            "type":"string",
            "description":"ID of the subject transfer",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.5"
        },
        "codeBreak":{
            "type":"string",
            "description":"Reveals the Treatment arm of a subject and the kits dispensed along with their description.",
            "example":"Treatment arm B"
        },
        "mhealthSubjectId":{
            "type":"string",
            "description":"ID of the mhealth subject",
            "format":"uuid"
        },
        "randomized":{
            "type":"boolean",
            "description":"Indicate if subject is randomized.",
            "example":true
        }
    },
    "description":"DCS Subject details."
}

404 Response

The study identifier does not match any study identifiers in Clinical One or site not found.

Body ()

Root Schema : ORSResponse

Type: object

Common response 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
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result 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

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response 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
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result 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