1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. Visits Status
  5. Get list of visits status

[Deprecated]: V1.0
get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus

Deprecated: Retrieves the list of visits status for a event ID. If the event ID is null, then it lists all the visit status records for a subject.

Request

Path Parameters
Query Parameters

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 : VisitsStatus
Type: object
Details of the visit for screening.
Show Source
  • Minimum Length: 0
    Maximum Length: 100
    Associated study version, if visit is linked to another protocol version.
    Example: 3.1.0.2
  • Minimum Length: 0
    Maximum Length: 2048
    Comment regarding the last change made to the entity.
    Example: Imported via migration tool.
  • Design version for the study when visit was enerated.
    Example: 3.1.0.2
  • Display indicator flag (Y/N), whether this visit should display in UIs.
    Example: Y
  • Holds any dose hold action taken on this visit.
    Example: ENABLE
  • Indicates if visit is part of dynamic all cycles (Y/N).
    Example: N
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: D1AABBCCDDEEFF112233445566778899
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN.
    Example: Freezed
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) for visit status.
    Example: AABBCCDDEEFF00112233445566778899
  • Unique Identfier ( (UUID, 32-character uppercase hexadecimal string) of the leading data element for this visit, if any.
    Example: EEDD00112233445566778899AABBCCDD
  • Date/time when the visit was locked (if applicable).
    Example: 2025-10-02T12:00:00Z
  • Lock status specifically for the visit start date.Values can be LOCKED, UNLOCKED, NEVER_LOCKED, NOT_APPLICABLE
    Example: UNLOCKED
  • Minimum Length: 1
    Maximum Length: 16
    Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: REMOVED
  • Minimum Length: 0
    Maximum Length: 255
    Reason for the entity creation or latest modification.
    Example: Initial import.
  • Count of repeating forms related to visit.
    Example: 0
  • holds visit schedule date which is calculated from an anchor visit start date.
    Example: 2025-10-02T09:00:00Z
  • holds visit schedule end date which is calculated from the visit scheduledDate.
    Example: 2025-10-03T23:59:59Z
  • Event ID (UUID, 32-character uppercase hexadecimal string) from which the schedule for this visit was derived.
    Example: EEDD00112233445566778899AABBCCDD
  • holds visit schedule start date which is calculated from the visit scheduledDate.
    Example: 2025-10-02T00:00:00Z
  • Scheduled window end date for the visit (dynamic calculation).
    Example: 2025-10-05T23:59:59Z
  • Scheduled window start date (dynamic calculation for visit scheduling).
    Example: 2025-09-30T00:00:00Z
  • 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: BEEFAABBCCDDEEDDFF00112233445566
  • 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.1.0.2
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: AABBCCDDEEFF00112233445566778899
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • 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: ENABLE
  • Date/time the visit was started.
    Example: 2025-10-02T08:45:00Z
  • Datetime when visit start date was locked.
    Example: 2025-10-02T12:00:00Z
  • Action taken on the visit start date value. Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.
    Example: LOCKED
  • 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: COMPLETED
  • 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
  • Window warning details or messages for visit timing.
    Example: Visit outside of permitted window.

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
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