1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Data Integration
  4. Visits Status
  5. Get visit status for subjects by date range

v1.0

get

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

Returns visit status records for subjects filtered by site and date range using cursor pagination.

Supported filter points:

  • Site-level retrieval: supply siteId. This API is site-scoped.
  • Date-range retrieval: supply startDate and endDate.
  • Only active visit status records are returned.

The inclusive date range is applied to versionStart; records are eligible when versionStart >= startDate and versionStart <= endDate. The response is ordered by versionStart in ascending order.

Cursor pagination: omit pageToken on the first request. Invoke the next-page request only when hasMore is true. To retrieve the complete data set, pass the previous response nextPageToken as the next request pageToken exactly as received. Consumers must not modify nextPageToken. In the corner case where the response contains records equal to the requested limit, hasMore may still be true and nextPageToken may be returned even when no additional records are available.

First request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/visitstatus/subjects/dateRange?siteId=ABCDEF1234567890ABCDEF1234567890&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&limit=25

Next-page request example: /v1.0/studies/ABCDEF1234567890ABCDEF1234567890/active/visitstatus/subjects/dateRange?siteId=ABCDEF1234567890ABCDEF1234567890&startDate=01-Jun-2026%2009:15:30.123&endDate=01-Jun-2026%2010:15:30.456&pageToken=MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ&limit=25

Request

Path Parameters
  • Indicates the operational mode of the study. Accepted values: active, test, or training.
    Example:
    active
  • Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    ABCDEF1234567890ABCDEF1234567890
Query Parameters
  • Inclusive date-range end in dd-MMM-yyyy HH:mm:ss.SSS format. Inclusive means records with versionStart on or before this value are eligible. The end date must be later than the start date.
    Example:
    01-Jun-2026 10:15:30.456
  • Minimum Value: 1
    Maximum Value: 10000
    Required. Maximum number of records to return. Accepted values are positive integers from 1 through 10000; negative values are not accepted. The value is an upper bound; fewer records may be returned when no additional matching records exist.
    Example:
    25
  • Opaque cursor token returned as nextPageToken from the previous page. Do not parse or modify this value. Omit it on the first request.
    Example:
    MTc1MDc2ODgwMDAwMDoxQkMyOUIzNkY1RDY0QjFCOTVGNEJEQkJDRUE0ODFCRQ
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example:
    ABCDEF1234567890ABCDEF1234567890
  • Inclusive date-range start in dd-MMM-yyyy HH:mm:ss.SSS format. Inclusive means records with versionStart on or after this value are eligible.
    Example:
    01-Jun-2026 09:15:30.123

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful response with cursor metadata and visit status records grouped by subject. The result object contains hasMore, limit, nextPageToken, and resultData.
Body ()
Root Schema : VisitStatusDateRangeResponse
Type: object
Response body containing visit status date-range results.
Show Source
Nested Schema : errorData
Type: object
Example:
oracle.doceng.json.BetterJsonNull@6f030247
Nested Schema : VisitStatusDateRangeCursor
Type: object
Cursor metadata and visit status records grouped by subject.
Show Source
Nested Schema : resultData
Type: array
Show Source
Nested Schema : VisitStatusDateRangeSubjectDto1
Type: object
Subject-level visit status date-range response record with visit status and schedule details.
Show Source
Nested Schema : scheduledVisits
Type: array
List of scheduled visits with scheduling windows.
Show Source
Nested Schema : visits
Type: array
List of visit status records for the subject.
Show Source
Nested Schema : ScheduledVisitsDto
Type: object
Base scheduled visit details including scheduling windows and identifiers
Show Source
Nested Schema : VisitStatusDateRangeVisitDto1
Type: object
Visit status audit record returned inside a subject-level date-range response.
Show Source
  • Study version with which the visit status is associated.
    Example: 3.0.0.1
  • Additional comment for the visit status.
    Example: All data captured
  • 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: ADF5A7800A954FA5B831E7B6B9CA39A9
  • 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_Complete
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.
    Example: NEVER_FROZEN
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Timestamp when the visit was locked.
  • Locked status of the visit. Can have values LOCKED, UNLOCKED or NEVER_LOCKED.
    Example: NEVER_LOCKED
  • Audit trail field that represents the version number of the data.
    Example: 14
  • Operation type applied on the visit status.
    Example: UPDATED
  • Reason associated with the visit status.
    Example: Visit completed
  • Number of repeating form instances for the visit.
    Example: 2
  • Scheduled window end date for the visit.
    Example: 2026-06-24T23:59:59.999Z
  • Scheduled window start date for the visit.
    Example: 2026-06-24T00:00:00Z
  • Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.
    Example: NEVER_SIGNED
  • Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Software version number
    Example: 14
  • 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: 10F75668189F422F9A461A315D211111
  • 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: NEVER_VERIFIED
  • End timestamp of the visit status version record.
    Example: 3099-12-31T00:00:00Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2026-06-24T10:00:00Z
  • 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.
    Example: 2026-06-24T09:00:00Z
  • Timestamp when the visit start date was locked.
  • Locked status for the visit start date. Can have values LOCKED, UNLOCKED or NEVER_LOCKED.
    Example: NEVER_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: 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: SCHEDULED
Examples

400 Response

Bad request. Returned for validation failures. The response provides a distinct validation message in errorData.details for each failed filter or cursor rule, including invalid date format, missing required parameters, endDate not later than startDate, invalid siteId, unsupported offset parameter, invalid pageToken, or limit outside 1 through 10000.
Body ()
Root Schema : RestResponse
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"
}
Examples

401 Response

Unauthorized. Returned when the request does not contain a valid authenticated session or token.
Body ()
Root Schema : RestResponse
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"
}
Examples

403 Response

Forbidden. Returned when the authenticated user does not have access to the requested site.
Body ()
Root Schema : RestResponse
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"
}
Examples

404 Response

Not found. Returned when the API is not available.
Body ()
Root Schema : RestResponse
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"
}
Examples

500 Response

Internal server error. Returned for unexpected service or downstream failures.
Body ()
Root Schema : RestResponse
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"
}
Examples

Back to Top