Get list of visits
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/visits
Retrieves a list of visits. Rights: SupplySettingRightsGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : Visit
Type:
object
Contains visit details.
Show Source
-
anchorVisitId: string
(uuid)
Anchor visit Id.
-
anchorVisitVersionStart: string
(date-time)
Anchor version start.
-
designId: string
(uuid)
Design Id.
-
designVersionStart: string
(date-time)
Design version start.
-
externalVisitId: string
External visit identifier.Example:
Screening visit
-
id: string
(uuid)
ID of the visit
-
isDispensation: boolean
Indicate if this is a dispensation visit.Example:
true
-
isRepeating: boolean
Indicate if the visit is repeating.Example:
true
-
isRequired: boolean
-
isRequiredValue: boolean
Indicate if the visit is required.Example:
true
-
isScheduled: boolean
Indicate if the visit is scheduled.Example:
true
-
nextVisitDays: number
(double)
Number of days for the next visit.Example:
5
-
nextVisitHours: number
(double)
Number of hours for the next visit.Example:
5
-
rndDesignId: string
(uuid)
Randomization design Id.
-
rndDesignVersionStart: string
(date-time)
Randomization version start.
-
srcId: string
(uuid)
Id of the Visit.
-
srcVersionStart: string
(date-time)
Visit version start.
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
-
visitId: string
(uuid)
ID of the visit
-
visitNumber: number
(double)
Visit number.Example:
5
-
windowAfterDays: number
(double)
Number of days for window after the visit.Example:
5
-
windowAfterHours: number
(double)
Number of hours for window after the visit.Example:
5
-
windowBeforeDays: number
(double)
Number of days for window before the visit.Example:
5
-
windowBeforeHours: number
(double)
Number of hours for window before the visit.Example:
5
404 Response
For invalid study ID or version
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object