Jump to

• Request
• Response

V2.0

get

/ec-designer-svc/rest/v2.0/visitschedules/{studyId}/{version}

Retrieves the visit schedule in a study for a study version.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

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 StudyVisitScheduleDto v1.0
  Title: StudyVisitScheduleDto v1.0

  Study visit schedule details.

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

Nested Schema : StudyVisitScheduleDto v1.0

Type: object

Title: StudyVisitScheduleDto v1.0

Study visit schedule details.

Show Source

• dynamic: boolean
  Yes - if visit dynamic.

  Example: false
• formCount: integer (int32)
  Visit forms count

  Example: 1
• fromVisitId: string (uuid)
  Scheduled from visit GUID
• fromVisitTitle: string
  Scheduled from visit title

  Example: Week1
• id: string (uuid)
  Visit schedule GUID
• kitCount: integer (int32)
  Visit kits count

  Example: 1
• randomizationId: string (uuid)
  Randomization GUID
• refName: string
  Country name

  Example: WEEK2
• repeating: boolean
  Yes - if visit repeating.

  Example: false
• required: integer (int32)
  Visit scheduling delay window after (hours).

  Example: 1
• screening: integer (int32)
  1 - visit is screening

  Example: 1
• sequenced: integer (int32)
• studyId: string (uuid)
  Study GUID
• studyVersionStart: string (date-time)
  Study version start
• title: string
  Visit title

  Example: Week2
• type: string
  Visit type

  Example: ONSITE
• versionEnd: string (date-time)
  Version end
• versionStart: string (date-time)
  Version start
• visitScheduleId: string (uuid)
  Visit schedule GUID

{
    "title":"StudyVisitScheduleDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit schedule GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end",
            "format":"date-time"
        },
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "visitScheduleId":{
            "type":"string",
            "description":"Visit schedule GUID",
            "format":"uuid"
        },
        "randomizationId":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "fromVisitId":{
            "type":"string",
            "description":"Scheduled from visit GUID",
            "format":"uuid"
        },
        "fromVisitTitle":{
            "type":"string",
            "description":"Scheduled from visit title",
            "example":"Week1"
        },
        "title":{
            "type":"string",
            "description":"Visit title",
            "example":"Week2"
        },
        "refName":{
            "type":"string",
            "description":"Country name",
            "example":"WEEK2"
        },
        "screening":{
            "type":"integer",
            "description":"1 - visit is screening",
            "format":"int32",
            "example":1
        },
        "formCount":{
            "type":"integer",
            "description":"Visit forms count",
            "format":"int32",
            "example":1
        },
        "kitCount":{
            "type":"integer",
            "description":"Visit kits count",
            "format":"int32",
            "example":1
        },
        "dynamic":{
            "type":"boolean",
            "description":"Yes - if visit dynamic.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Yes - if visit repeating.",
            "example":false
        },
        "required":{
            "type":"integer",
            "description":"Visit scheduling delay window after (hours).",
            "format":"int32",
            "example":1
        },
        "type":{
            "type":"string",
            "description":"Visit type",
            "example":"ONSITE"
        },
        "sequenced":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Study visit schedule details."
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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 : details

Type: object

Back to Top