1. REST API for Oracle Clinical One PlatformREST API for Clinical One Platform
  2. Use cases
  3. Retrieve study information
  4. Get visit information

Get visit information

Retrieve information about visits and visit schedule.

Note:

  • To run these Oracle Clinical One Platform API calls, you need to include an authentication token. For instructions on how to generate your authentication token, see Get a token for authentication and Use the token to make an API request.
  • For every API call make sure you construct the URL using the correct server URL and path parameters values.
For the following API calls, you need the studyID, version and mode. These values are retrieved as part of a previous task, see Get study information.

Get a list of visits in a study

Run the following cURL command to get a list of visits in a study:

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits"

If you want to make subsequent calls for a specific visit, take note of the visitID value associated with the visit of your interest.

For more details on this API, like its parameters and response objects, see Get a list of study visits.

Get a list of forms in a visit

Run the following cURL command to get a list of forms in a visit:

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v16.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms"

If you want to make subsequent calls for a specific form, take note of the formID of your interest .

For more details on this API, like its parameters and response objects, see Get a list of forms in a visit.

Get visit schedule

Run the following cURL command to get the visit schedule of a study design:

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visitschedules"

For more details on this API, like its parameters and response objects, see Get study design visits.

Tip:

There are many different Clinical One APIs that could provide the information you are looking for. Browse for these and other related APIs under the Tasks section of this guide. If you see any deprecated endpoint, look for its newest version.