V5.0

post

/ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/randomizeordispense

Randomizes, dispenses or activates a subject, based on visit type, and completes the visit status. ORS dispensation or randomization is called.

Request

Path Parameters
  • Indicates the operational mode of the study. Accepted values: active, test, or training.
    Example:
    test
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    1BC29B36F5D64B1B95F4BDBBCEA481BE
Supported Media Types
Request Body - application/json ()
Root Schema : Visit Request
Type: object
Title: Visit Request
Request containing subject visit details.
Show Source
Nested Schema : AuthUserListDtoV1
Type: array
Show Source
Nested Schema : DCS Subject
Type: object
Title: DCS Subject
Subject properties indicating completion capability and the locked study version
Show Source
Nested Schema : Kit Types for Dose Hold
Type: array
Title: Kit Types for Dose Hold
List of kit types configured for dose hold.
Show Source
Nested Schema : Kit Types for Resume Dispensation
Type: array
Title: Kit Types for Resume Dispensation
List of kit types for which to resume dispensation.
Show Source
Nested Schema : Reusable Kits
Type: array
Title: Reusable Kits
Unique Items Required: true
IDs of kits that can be reused in the visit.
Show Source
Nested Schema : Visits
Type: array
Title: Visits
Visit status details.
Show Source
Nested Schema : Parameter
Type: object
Contains details about parameters of the form
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.
  • Value of the item
Nested Schema : Dose Hold Request
Type: object
Title: Dose Hold Request
Request containing dose hold settings.
Show Source
Nested Schema : VisitsStatusDto9
Type: object
Visit status details including associated study version
Show Source
  • Study version with which the visit status is associated
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 2048
    Additional comment for the visit status
    Example: All data verified
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.
    Example: 1
  • Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.
    Example: Visit_Not_Started
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.
    Example: FROZEN
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Audit trail field that represents the version number of the data.
    Example: 14
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: MODIFIED
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the visit status
    Example: Subject completed the visit successfully
  • Number of repeating form instances for the visit.
    Example: 2
  • Scheduled window end date for the visit
    Example: 2025-10-16T14:30:31.892Z
  • Scheduled window start date for the visit
    Example: 2025-10-16T14:30:31.892Z
  • Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.
    Example: SIGNED
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • A number that represents an incremental increase every time a data point is modified.
    Example: 14
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Read Only: true
    User identifier who performed the operation
    Example: 9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • Read Only: true
    End timestamp of the visit status version record
    Example: 2025-10-16T14:30:31.892Z
  • Start timestamp of the version record
    Example: 2025-10-16T14:30:31.892Z
  • Visit start date timestamp
    Example: 2025-10-16T14:30:31.892Z
  • Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.
    Example: COMPLETE
  • Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.
    Example: SCREENING
Examples

Back to Top

Response

Supported Media Types

200 Response

Success. The subject was randomized or drug dispensed.
Body ()
Root Schema : RandomizeDetails
Type: object
Title: RandomizeDetails
Contains randomization details with subject and visit summary.
Show Source
Nested Schema : VisitResult v15.0
Type: object
Title: VisitResult v15.0
Visit result.
Show Source
Nested Schema : SubjectDto10
Type: object
Subject attributes including screen failure date information
Show Source
  • Code break note if applicable. Values can Y or N.
    Example: N
  • 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
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.
    Example: FROZEN
  • 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
  • Timestamp when the subject was last signed
    Example: 2025-10-16T14:30:31.892Z
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the subject in mHealth system.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Audit trail field that represents the version number of the data.
    Example: 14
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: MODIFIED
  • Previous subject number if renumbered or transferred
    Example: SUBJECT-0001-OLD
  • Minimum Length: 0
    Maximum Length: 255
    Reason for latest subject update
    Example: Protocol break happened
  • Date when the subject was marked as screen failure
    Example: 2025-10-16T14:30:31.892Z
  • 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
  • Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.
    Example: SIGNED
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Software version number associated with the event
    Example: 14
  • Source system timestamp for the subject payload
    Example: 2025-10-16T14:30:31.892Z
  • Minimum Length: 0
    Maximum Length: 100
    Lifecycle state of the subject in the study. Reflects the subject’s current status. Common values include:
    • New
    • Active
    • Screening_Initiated
    • Screen_Failed
    • Withdrawn
    • Auto_Screen_Failed
    • Complete
    • Enrolled
    Example: Active
  • Timestamp when the subject transitioned to current state
    Example: 2025-10-16T14:30:31.892Z
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • String representing the version of the study. 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
  • Site-level serial number assigned to the subject
    Example: SITE-0001-001
  • Study-level serial number assigned to the subject
    Example: STUDY-0001-001
  • 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
  • Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: 9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • End timestamp of the subject version record
    Example: 2025-10-16T14:30:31.892Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
Nested Schema : VisitsStatusDto13
Type: object
Visit status including window warning and dose hold action fields
Show Source
  • Study version with which the visit status is associated
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 2048
    Additional comment for the visit status
    Example: All data verified
  • Dose hold action for the visit. The acceptable values are ENABLE or DISABLE
    Example: ENABLE
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.
    Example: 1
  • Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.
    Example: Visit_Not_Started
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.
    Example: FROZEN
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Timestamp when the visit was locked
    Example: 2025-10-16T14:30:31.892Z
  • Locked status of the visit. Can have values LOCKED,UNLOCKED or NEVER_LOCKED
    Example: UNLOCKED
  • Audit trail field that represents the version number of the data.
    Example: 14
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: MODIFIED
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the visit status
    Example: Subject completed the visit successfully
  • Number of repeating form instances for the visit.
    Example: 2
  • Scheduled window end date for the visit
    Example: 2025-10-16T14:30:31.892Z
  • Scheduled window start date for the visit
    Example: 2025-10-16T14:30:31.892Z
  • Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.
    Example: SIGNED
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • A number that represents an incremental increase every time a data point is modified.
    Example: 14
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Read Only: true
    User identifier who performed the operation
    Example: 9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • Read Only: true
    End timestamp of the visit status version record
    Example: 2025-10-16T14:30:31.892Z
  • Start timestamp of the version record
    Example: 2025-10-16T14:30:31.892Z
  • Action taken on the visit start date value. Acceptable values are SCREEN_ENABLE ,SCREEN_DISABLE ,RANDOMIZE_ENABLE ,RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE.
    Example: SCREEN_ENABLE
  • Visit start date timestamp
    Example: 2025-10-16T14:30:31.892Z
  • Timestamp when the visit start date was locked
    Example: 2025-10-16T14:30:31.892Z
  • Locked status for the visit start date.Can have values LOCKED,UNLOCKED or NEVER_LOCKED
    Example: UNLOCKED
  • Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.
    Example: COMPLETE
  • Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.
    Example: SCREENING
  • Warning for the visit scheduling window
    Example: NONE
Nested Schema : kits
Type: array
Show Source
Nested Schema : DispensationKit v12.0
Type: object
Title: DispensationKit v12.0
Contains information for the kit dispensation.
Show Source
Examples

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}

500 Response

Internal server error.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • 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
Nested Schema : result
Type: object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Example:
{
    "field":"studyId",
    "reason":"Invalid value"
}
Back to Top