Jump to

• Request
• Response

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 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)
  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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "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"
        },
        "isRequiredValue":{
            "type":"boolean",
            "description":"Indicate if the visit is required.",
            "example":true
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        }
    },
    "description":"Contains visit details."
}

404 Response

For invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top