Jump to

• Request
• Response

v1.0

get

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

Retrieves a list of visits.
Rights: SupplySettingRightsGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Visit
  Contains visit details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Visit"
    }
}

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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) 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)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.
• visitId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "externalVisitId":{
            "type":"string",
            "description":"External visit identifier.",
            "example":"Screening visit"
        },
        "nextVisitDays":{
            "type":"number",
            "description":"Number of days for the next visit.",
            "format":"double",
            "example":5
        },
        "nextVisitHours":{
            "type":"number",
            "description":"Number of hours for the next visit.",
            "format":"double",
            "example":5
        },
        "windowBeforeDays":{
            "type":"number",
            "description":"Number of days for window before the visit.",
            "format":"double",
            "example":5
        },
        "windowBeforeHours":{
            "type":"number",
            "description":"Number of hours for window before the visit.",
            "format":"double",
            "example":5
        },
        "windowAfterDays":{
            "type":"number",
            "description":"Number of days for window after the visit.",
            "format":"double",
            "example":5
        },
        "windowAfterHours":{
            "type":"number",
            "description":"Number of hours for window after the visit.",
            "format":"double",
            "example":5
        },
        "rndDesignId":{
            "type":"string",
            "description":"Randomization design Id.",
            "format":"uuid"
        },
        "rndDesignVersionStart":{
            "type":"string",
            "description":"Randomization version start.",
            "format":"date-time"
        },
        "visitNumber":{
            "type":"number",
            "description":"Visit number.",
            "format":"double",
            "example":5
        },
        "designId":{
            "type":"string",
            "description":"Design Id.",
            "format":"uuid"
        },
        "designVersionStart":{
            "type":"string",
            "description":"Design version start.",
            "format":"date-time"
        },
        "isRequired":{
            "type":"boolean",
            "writeOnly":true
        },
        "isRepeating":{
            "type":"boolean",
            "description":"Indicate if the visit is repeating.",
            "example":true
        },
        "isScheduled":{
            "type":"boolean",
            "description":"Indicate if the visit is scheduled.",
            "example":true
        },
        "isDispensation":{
            "type":"boolean",
            "description":"Indicate if this is a dispensation visit.",
            "example":true
        },
        "anchorVisitId":{
            "type":"string",
            "description":"Anchor visit Id.",
            "format":"uuid"
        },
        "anchorVisitVersionStart":{
            "type":"string",
            "description":"Anchor version start.",
            "format":"date-time"
        },
        "srcId":{
            "type":"string",
            "description":"Id of the Visit.",
            "format":"uuid"
        },
        "srcVersionStart":{
            "type":"string",
            "description":"Visit version start.",
            "format":"date-time"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "isRequiredValue":{
            "type":"boolean",
            "description":"Indicate if the visit is required.",
            "example":true
        }
    },
    "description":"Contains visit details."
}

Examples

Select an example Visits Response

404 Response

For invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Visits Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  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

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"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"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Visits Server Error Response

Back to Top