1. REST API for Clinical One Platform
  2. Tasks
  3. Randomization and Supplies
  4. Visit APIs
  5. v15.0

[Deprecated]: Randomize subject or dispense kit during visit
post

/ec-ors-svc/rest/v15.0/studies/{studyId}/{mode}/visits/subjectvisit

Deprecated: Randomize a subject and/or dispense kits during a randomization or dispensation visit. This version of the API enables to send request with resumePartialDispensation to resume partial dispensation and pendingKitQuantity field in response.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
All details of visits.
Show Source
Nested Schema : SubjectDto12
Type: object
Subject properties indicating completion capability and the locked study version
Show Source
Nested Schema : kitTypesForDoseHold
Type: object
Contains details about kits which are to be hold or dispensed
Show Source
  • type of device being used.These can be Activity watch, Blood pressure monitor, Weight scale, ECG reader, Spirometer, Mobile App, Smart Pill Bottle, Pulse Oximeter, Wearable Patch
    Example: Spirometer
  • is current medication a titration
    Example: true
  • treatment assignment information that is can be or can not be visible to study personne
    Example: true
  • kitTypeSrcId (UUID, 32-character uppercase hexadecimal string) of the kit
  • trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX
    Example: BOTTLE
Nested Schema : kitTypesForResumeDispensation
Type: object
Contains details about kits which are to be hold or dispensed
Show Source
  • type of device being used.These can be Activity watch, Blood pressure monitor, Weight scale, ECG reader, Spirometer, Mobile App, Smart Pill Bottle, Pulse Oximeter, Wearable Patch
    Example: Spirometer
  • is current medication a titration
    Example: true
  • treatment assignment information that is can be or can not be visible to study personne
    Example: true
  • kitTypeSrcId (UUID, 32-character uppercase hexadecimal string) of the kit
  • trail supplly type can be of type BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX
    Example: BOTTLE
Nested Schema : parameters
Type: object
Contains details about parameters of the form
Show Source
Nested Schema : reusableKits
Type: array
Unique Items Required: true
Show Source
Nested Schema : visits
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) representing the clinical event like Screening, Visit 1 etc.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. 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.
    Example: FROZEN
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • 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 (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • 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
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : VisitResult
Type: object
Show Source
Nested Schema : DispensationKit
Type: object
Title: DispensationKit
Contains information for the kit dispensation
Show Source

400 Response

Invalid visit timestamp OR You must associate the randomization design with a visit before you can create/upload a randomization list for it OR The next step in this visit isn???t allowed for subject because the study version at your site isn???t compatible with the subject OR Subject can't be Re-randomized before randomization OR This operation is not allowed in the current subject status
Body ()
Root Schema : ORSResponse
Type: object
Common response 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
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

404 Response

Invalid study ID or version OR Rand List not found OR Design not found
Body ()
Root Schema : ORSResponse
Type: object
Common response 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
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

Unsupported Visit OR Subject already completed the visit OR Subject is randomized in error OR Invalid treatment found for the subject OR Visit out of order OR This operation is not allowed in the current subject status OR Visit is outside visit window OR Visit is outside visit window and at least one kit is configured not to dispense outside visit window OR Not enough inventory.
Body ()
Root Schema : ORSResponse
Type: object
Common response 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
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