1. REST API for Clinical One Platform
  2. Tasks
  3. Data Integration
  4. Subjects
  5. Get a subject's events within a date range

[Deprecated]:v1.0
get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}

Retrieves the events for a specific subject within a specified date range. Used by Digital Gateway to retrieve events associated with a specific subject.

Request

Path Parameters
  • Mode of the study, accepts: test, active, or training.
    Example:
    test
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example:
    3F2504E04F8911D39A0C0305E82C3301
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example:
    93CC828113AC439181071CB44D2C6FE5
Query Parameters
  • The ending date and time (optional) for which you want to get events. If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
    Example:
    26-Oct-2023 14:30:15.123
  • The starting date and time (optional) for which you want to get events. If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
    Example:
    25-Oct-2023 14:30:15.123

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Subjects success.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : SubjectDto5
Type: object
Subject details extended with study origin and subject number site organization identifier
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for latest subject update
    Example: Initial enrollment
  • Minimum Length: 0
    Maximum Length: 500
    Free text description for the subject
    Example: Screened subject
  • Date of birth
  • Minimum Length: 0
    Maximum Length: 255
    Reason for enrollment failure, if any
    Example: Consent withdrawn
  • Minimum Length: 0
    Maximum Length: 255
    If subject enrollment is overridden.
    Example: Subject Enrollment Overridden
  • Event Type for Subject, can have value New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Randomization_Replaced, Transferred, Screen_Failed, Undo_Randomization.
    Example: Screened
  • Origin study identifier (UUID, 32-character uppercase hexadecimal string) from which the subject was transferred
    Example: 5D5F9311C591424F852B99FD902E98A4
  • Minimum Length: 0
    Maximum Length: 10
    Gender value
    Example: [{"value":"1","label":"male"}]
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Informed consent date
    Example: 2025-09-25T09:00:00Z
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the subject in mHealth system.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Object version number
    Example: 14
  • Minimum Length: 0
    Maximum Length: 255
    Reason for latest subject update
    Example: Protocol break happened
  • Screening date if applicable
    Example: 2025-10-01T10:00:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for screening failure, if any
    Example: Inclusion criteria not met
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.
    Example: Active
  • Timestamp when the subject transitioned to current state
    Example: 2025-10-16T14:30:31.892Z
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 500
    Unique subject Number representing the patient/participant enrolled in the study.
    Example: SUBJ-0001
  • Unique Identifier(UUID, 32-character uppercase hexadecimal string) of a subject transfer if applicable
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Subject number site organization identifier (UUID, 32-character uppercase hexadecimal string)
    Example: 5D5F9311C591424F852B99FD902E98A4
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
Examples

400 Response

Bad request.
Body ()
Root Schema : RestResponse
Type: object
Show Source
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
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
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