Jump to

• Request
• Response

v11.0

get

/ec-designer-study-svc/rest/v11.0/studies/{studyId}/versions/{version}/design

Retrieves v11.0 visit design for the requested study version. Compared with v10.0, this version includes nextVisitWithoutCompletion.

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

Query Parameters

• isLiteAPI: boolean
  If true, generate light version of the API. Optional.

  Default Value: true

  Example:

  true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : RespVisitBranchDesignDto

Type: object

Show Source

• branchVisits: array branchVisits
  Branch visit designs.
• scheduledVisits: array scheduledVisits
  Scheduled visit designs.
• unscheduledVisits: array unscheduledVisits
  Unscheduled visit designs.

{
    "type":"object",
    "properties":{
        "scheduledVisits":{
            "type":"array",
            "description":"Scheduled visit designs.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV11"
            }
        },
        "branchVisits":{
            "type":"array",
            "description":"Branch visit designs.",
            "example":[
            ],
            "items":{
                "type":"array",
                "description":"Branch visit designs.",
                "example":[
                ],
                "items":{
                    "$ref":"#/components/schemas/BranchDesignDtoV11"
                }
            }
        },
        "unscheduledVisits":{
            "type":"array",
            "description":"Unscheduled visit designs.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV11"
            }
        }
    }
}

Nested Schema : branchVisits

Type: array

Branch visit designs.

Show Source

• Array of: array items
  Branch visit designs.

{
    "type":"array",
    "description":"Branch visit designs.",
    "example":[
    ],
    "items":{
        "type":"array",
        "description":"Branch visit designs.",
        "example":[
        ],
        "items":{
            "$ref":"#/components/schemas/BranchDesignDtoV11"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Scheduled visit designs.

Show Source

• Array of: object VisitDesignDto v11.0
  Title: VisitDesignDto v11.0

  Visit design information.

{
    "type":"array",
    "description":"Scheduled visit designs.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV11"
    }
}

Nested Schema : unscheduledVisits

Type: array

Unscheduled visit designs.

Show Source

• Array of: object VisitDesignDto v11.0
  Title: VisitDesignDto v11.0

  Visit design information.

{
    "type":"array",
    "description":"Unscheduled visit designs.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV11"
    }
}

Nested Schema : items

Type: array

Branch visit designs.

Show Source

• Array of: object BranchDesignDto v11.0
  Title: BranchDesignDto v11.0

  Branch design properties.

{
    "type":"array",
    "description":"Branch visit designs.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/BranchDesignDtoV11"
    }
}

Nested Schema : BranchDesignDto v11.0

Type: object

Title: BranchDesignDto v11.0

Branch design properties.

Show Source

• branch: object VisitBranchDto v11.0
  Title: VisitBranchDto v11.0

  Visit branch details.
• visits: array visits
  The visits in this branch.

{
    "title":"BranchDesignDto v11.0",
    "type":"object",
    "properties":{
        "branch":{
            "$ref":"#/components/schemas/VisitBranchDtoV11"
        },
        "visits":{
            "type":"array",
            "description":"The visits in this branch.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV11"
            }
        }
    },
    "description":"Branch design properties.",
    "example":[
    ]
}

Nested Schema : VisitBranchDto v11.0

Type: object

Title: VisitBranchDto v11.0

Visit branch details.

Show Source

• arms: array arms
  Arm details.
• branchIndex: integer (int32)
  Index information for the branch in the tier.

  Example: 10
• branchTier: integer (int32)
  Tier information for the branch.

  Example: 10
• cycleCount: number
  Number of times a branch can cycle.

  Example: 10
• forms: array forms
  Form details.
• formVisits: array formVisits
  Visit details.
• id: string (uuid)
  Visit branch GUID.
• isCycle(required): boolean
  Indicates whether the branch is cyclic or acyclic.

  Example: true
• isRestartCycle: boolean
  Indicates whether the branch cycle needs a restart of the cycle count.

  Example: true
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 32

  Visit branch short name.

  Example: Br2
• startCycle: integer (int32)
  Start cycle number.
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit branch title.

  Example: Branch 2

{
    "title":"VisitBranchDto v11.0",
    "required":[
        "isCycle",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit branch GUID.",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit branch title.",
            "example":"Branch 2"
        },
        "shortName":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Visit branch short name.",
            "example":"Br2"
        },
        "isCycle":{
            "type":"boolean",
            "description":"Indicates whether the branch is cyclic or acyclic.",
            "example":true
        },
        "cycleCount":{
            "type":"number",
            "description":"Number of times a branch can cycle.",
            "example":10
        },
        "branchTier":{
            "type":"integer",
            "description":"Tier information for the branch.",
            "format":"int32",
            "example":10
        },
        "branchIndex":{
            "type":"integer",
            "description":"Index information for the branch in the tier.",
            "format":"int32",
            "example":10
        },
        "arms":{
            "type":"array",
            "description":"Arm details.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "forms":{
            "type":"array",
            "description":"Form details.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "formVisits":{
            "type":"array",
            "description":"Visit details.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "startCycle":{
            "type":"integer",
            "description":"Start cycle number.",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"boolean",
            "description":"Indicates whether the branch cycle needs a restart of the cycle count.",
            "example":true
        }
    },
    "description":"Visit branch details.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "title":"Branch 2",
        "shortName":"Br2"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "title":"Branch 2",
    "shortName":"Br2"
}

Nested Schema : visits

Type: array

The visits in this branch.

Show Source

• Array of: object VisitDesignDto v11.0
  Title: VisitDesignDto v11.0

  Visit design information.

{
    "type":"array",
    "description":"The visits in this branch.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV11"
    }
}

Nested Schema : arms

Type: array

Arm details.

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Arm details.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : forms

Type: array

Form details.

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Form details.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : formVisits

Type: array

Visit details.

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Visit details.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : From Item Advanced Property v11.0

Type: object

Title: From Item Advanced Property v11.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v11.0",
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov11"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v11.0
  Title: From Item Advanced Property Rule v11.0

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v11.0

Type: object

Title: From Item Advanced Property Rule v11.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v11.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : VisitDesignDto v11.0

Type: object

Title: VisitDesignDto v11.0

Visit design information.

Show Source

• branchId: string (uuid)
  The ID of the branch.
• dispensings: object VisitDesignDispensingDto v11.0
  Title: VisitDesignDispensingDto v11.0

  Visit design dispensing properties.
• endVisitId: string (uuid)
  Visit design end visit ID.
• eventType: string
  Visit design event type.

  Example: ScreeningVisit
• forms: object VisitDesignAssignedFormsDto v11.0
  Title: VisitDesignAssignedFormsDto v11.0

  Visit design assigned forms properties.
• id: string (uuid)
  Visit design unique GUID.
• randomization: object VisitDesignRandomizationDto v11.0
  Title: VisitDesignRandomizationDto v11.0

  Visit design randomization properties.
• scheduling: object VisitDesignSchedulingDto v11.0
  Title: VisitDesignSchedulingDto v11.0

  Visit design scheduling properties.
• shortName: string
  Visit design short name.

  Example: Week1
• startVisitId: string (uuid)
  Visit design start visit ID.
• state: object VisitDesignStateDto v11.0
  Title: VisitDesignStateDto v11.0

  Visit design state properties.
• title: string
  Visit design title.

  Example: Week1

{
    "title":"VisitDesignDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit design unique GUID.",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit design title.",
            "example":"Week1"
        },
        "eventType":{
            "type":"string",
            "description":"Visit design event type.",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "type":"string",
            "description":"Visit design short name.",
            "example":"Week1"
        },
        "state":{
            "$ref":"#/components/schemas/VisitDesignStateDtoV11"
        },
        "scheduling":{
            "title":"VisitDesignSchedulingDto v11.0",
            "type":"object",
            "properties":{
                "fromVisitId":{
                    "type":"string",
                    "description":"Visit design from visit GUID.",
                    "format":"uuid"
                },
                "branchId":{
                    "type":"string",
                    "description":"Branch GUID.",
                    "format":"uuid"
                },
                "delay":{
                    "$ref":"#/components/schemas/Delay"
                },
                "beforeDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "afterDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "outOfWindowAlert":{
                    "type":"string",
                    "description":"Outside visit window alert.",
                    "format":"string",
                    "example":"OFF"
                }
            },
            "description":"Visit design scheduling properties.",
            "example":[
                {
                    "fromVisitId":"66C8628FB6594912B3214E294A5D4E9F",
                    "outOfWindowAlert":"OFF"
                }
            ]
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV11"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDTOV11"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV11"
        },
        "startVisitId":{
            "type":"string",
            "description":"Visit design start visit ID.",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"Visit design end visit ID.",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"The ID of the branch.",
            "format":"uuid"
        }
    },
    "description":"Visit design information.",
    "example":[
    ]
}

Nested Schema : VisitDesignDispensingDto v11.0

Type: object

Title: VisitDesignDispensingDto v11.0

Visit design dispensing properties.

Show Source

• advancedDispensationCount: integer (int32)
  Visit design advanced dispensation count.

  Example: 1
• deviceCount: integer (int32)
  Visit design device count.

  Example: 1
• id: integer (int32)
  Visit design titration count.

  Example: 1

{
    "title":"VisitDesignDispensingDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Visit design titration count.",
            "format":"int32",
            "example":1
        },
        "deviceCount":{
            "type":"integer",
            "description":"Visit design device count.",
            "format":"int32",
            "example":1
        },
        "advancedDispensationCount":{
            "type":"integer",
            "description":"Visit design advanced dispensation count.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design dispensing properties.",
    "example":{
        "count":1,
        "titrationCount":0,
        "deviceCount":0,
        "advancedDispensationCount":0
    }
}

Example:

{
    "count":1,
    "titrationCount":0,
    "deviceCount":0,
    "advancedDispensationCount":0
}

Nested Schema : VisitDesignAssignedFormsDto v11.0

Type: object

Title: VisitDesignAssignedFormsDto v11.0

Visit design assigned forms properties.

Show Source

• id: integer (int32)
  Visit design assigned forms count.

  Example: 1

{
    "title":"VisitDesignAssignedFormsDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Visit design assigned forms count.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design assigned forms properties.",
    "example":{
        "count":2
    }
}

Example:

{
    "count":2
}

Nested Schema : VisitDesignRandomizationDto v11.0

Type: object

Title: VisitDesignRandomizationDto v11.0

Visit design randomization properties.

Show Source

• algorithmType: string
  Visit design randomization algorithm type.

  Example: 1
• id: string (uuid)
  Visit design randomization unique GUID.
• treatmentArms: string
  Visit design randomization treatment arms to be remapped.

  Example: 1
• type: string
  Visit design randomization type.

  Example: 1
• visits: array visits
  Visit design randomization visit GUIDs.

{
    "title":"VisitDesignRandomizationDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit design randomization unique GUID.",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit design randomization type.",
            "example":"1"
        },
        "visits":{
            "type":"array",
            "description":"Visit design randomization visit GUIDs.",
            "example":[
                "55C8628FB6594912B3214E294A5D4E9F"
            ],
            "items":{
                "type":"string",
                "description":"Visit design randomization visit GUIDs.",
                "format":"uuid"
            }
        },
        "algorithmType":{
            "type":"string",
            "description":"Visit design randomization algorithm type.",
            "example":"1"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit design randomization treatment arms to be remapped.",
            "example":"1"
        }
    },
    "description":"Visit design randomization properties.",
    "example":{
        "id":"44C8628FB6594912B3214E294A5D4E9F",
        "type":"Blinded"
    }
}

Example:

{
    "id":"44C8628FB6594912B3214E294A5D4E9F",
    "type":"Blinded"
}

Nested Schema : VisitDesignSchedulingDto v11.0

Type: object

Title: VisitDesignSchedulingDto v11.0

Visit design scheduling properties.

Show Source

• afterDelayWindow: object Delay
  Visit design scheduling before-delay window
• beforeDelayWindow: object Delay
  Visit design scheduling before-delay window
• branchId: string (uuid)
  Branch GUID.
• delay: object Delay
  Visit design scheduling before-delay window
• fromVisitId: string (uuid)
  Visit design from visit GUID.
• outOfWindowAlert: string (string)
  Outside visit window alert.

  Example: OFF

{
    "title":"VisitDesignSchedulingDto v11.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit design from visit GUID.",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch GUID.",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/Delay"
        },
        "beforeDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "outOfWindowAlert":{
            "type":"string",
            "description":"Outside visit window alert.",
            "format":"string",
            "example":"OFF"
        }
    },
    "description":"Visit design scheduling properties.",
    "example":[
        {
            "fromVisitId":"66C8628FB6594912B3214E294A5D4E9F",
            "outOfWindowAlert":"OFF"
        }
    ]
}

Example:

[
    {
        "fromVisitId":"66C8628FB6594912B3214E294A5D4E9F",
        "outOfWindowAlert":"OFF"
    }
]

Nested Schema : VisitDesignStateDto v11.0

Type: object

Title: VisitDesignStateDto v11.0

Visit design state properties.

Show Source

• dynamic: boolean
  Visit design dynamic state.

  Example: false
• lastRequired: boolean
  Visit design last required state.

  Example: false
• nextVisitWithoutCompletion: boolean
  Indicates whether the next eligible visit can be started before this visit is complete. True and false apply to eligible Scheduled, Rescreening, and Screen Failure visits; null indicates the setting is not applicable.

  Example: false
• repeating: boolean
  Visit design repeating state.

  Example: false
• required: boolean
  Visit design required state.

  Example: true
• timeLine: integer (int32)
  Shows the visit in the timeline and lets the designer set when it can be shown to a user.

  Example: 1

{
    "title":"VisitDesignStateDto v11.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Visit design dynamic state.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Visit design repeating state.",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Visit design required state.",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Visit design last required state.",
            "example":false
        },
        "timeLine":{
            "type":"integer",
            "description":"Shows the visit in the timeline and lets the designer set when it can be shown to a user.",
            "format":"int32",
            "example":1
        },
        "nextVisitWithoutCompletion":{
            "type":"boolean",
            "description":"Indicates whether the next eligible visit can be started before this visit is complete. True and false apply to eligible Scheduled, Rescreening, and Screen Failure visits; null indicates the setting is not applicable.",
            "example":false
        }
    },
    "description":"Visit design state properties.",
    "example":{
        "dynamic":false,
        "repeating":false,
        "required":true,
        "lastRequired":false,
        "timeLine":1
    }
}

Example:

{
    "dynamic":false,
    "repeating":false,
    "required":true,
    "lastRequired":false,
    "timeLine":1
}

Nested Schema : visits

Type: array

Visit design randomization visit GUIDs.

Show Source

• Array of: string(uuid)
  Visit design randomization visit GUIDs.

{
    "type":"array",
    "description":"Visit design randomization visit GUIDs.",
    "example":[
        "55C8628FB6594912B3214E294A5D4E9F"
    ],
    "items":{
        "type":"string",
        "description":"Visit design randomization visit GUIDs.",
        "format":"uuid"
    }
}

Example:

[
    "55C8628FB6594912B3214E294A5D4E9F"
]

Nested Schema : Delay

Type: object

Visit design scheduling before-delay window

Show Source

• days: integer (int32)
  Minimum Value: 0

  Maximum Value: 365
• hours: integer (int32)
  Minimum Value: 0

  Maximum Value: 24

{
    "type":"object",
    "properties":{
        "days":{
            "maximum":365,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "maximum":24,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Visit design scheduling before-delay window"
}

Examples

Select an example successResponse

204 Response

Successful operation.

Body ()

Root Schema : RespVisitBranchDesignDto

Type: object

Show Source

• branchVisits: array branchVisits
  Branch visit designs.
• scheduledVisits: array scheduledVisits
  Scheduled visit designs.
• unscheduledVisits: array unscheduledVisits
  Unscheduled visit designs.

{
    "type":"object",
    "properties":{
        "scheduledVisits":{
            "type":"array",
            "description":"Scheduled visit designs.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV11"
            }
        },
        "branchVisits":{
            "type":"array",
            "description":"Branch visit designs.",
            "example":[
            ],
            "items":{
                "type":"array",
                "description":"Branch visit designs.",
                "example":[
                ],
                "items":{
                    "$ref":"#/components/schemas/BranchDesignDtoV11"
                }
            }
        },
        "unscheduledVisits":{
            "type":"array",
            "description":"Unscheduled visit designs.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV11"
            }
        }
    }
}

Nested Schema : branchVisits

Type: array

Branch visit designs.

Show Source

• Array of: array items
  Branch visit designs.

{
    "type":"array",
    "description":"Branch visit designs.",
    "example":[
    ],
    "items":{
        "type":"array",
        "description":"Branch visit designs.",
        "example":[
        ],
        "items":{
            "$ref":"#/components/schemas/BranchDesignDtoV11"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

Scheduled visit designs.

Show Source

• Array of: object VisitDesignDto v11.0
  Title: VisitDesignDto v11.0

  Visit design information.

{
    "type":"array",
    "description":"Scheduled visit designs.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV11"
    }
}

Nested Schema : unscheduledVisits

Type: array

Unscheduled visit designs.

Show Source

• Array of: object VisitDesignDto v11.0
  Title: VisitDesignDto v11.0

  Visit design information.

{
    "type":"array",
    "description":"Unscheduled visit designs.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV11"
    }
}

Nested Schema : items

Type: array

Branch visit designs.

Show Source

• Array of: object BranchDesignDto v11.0
  Title: BranchDesignDto v11.0

  Branch design properties.

{
    "type":"array",
    "description":"Branch visit designs.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/BranchDesignDtoV11"
    }
}

Nested Schema : BranchDesignDto v11.0

Type: object

Title: BranchDesignDto v11.0

Branch design properties.

Show Source

• branch: object VisitBranchDto v11.0
  Title: VisitBranchDto v11.0

  Visit branch details.
• visits: array visits
  The visits in this branch.

{
    "title":"BranchDesignDto v11.0",
    "type":"object",
    "properties":{
        "branch":{
            "$ref":"#/components/schemas/VisitBranchDtoV11"
        },
        "visits":{
            "type":"array",
            "description":"The visits in this branch.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV11"
            }
        }
    },
    "description":"Branch design properties.",
    "example":[
    ]
}

Nested Schema : VisitBranchDto v11.0

Type: object

Title: VisitBranchDto v11.0

Visit branch details.

Show Source

• arms: array arms
  Arm details.
• branchIndex: integer (int32)
  Index information for the branch in the tier.

  Example: 10
• branchTier: integer (int32)
  Tier information for the branch.

  Example: 10
• cycleCount: number
  Number of times a branch can cycle.

  Example: 10
• forms: array forms
  Form details.
• formVisits: array formVisits
  Visit details.
• id: string (uuid)
  Visit branch GUID.
• isCycle(required): boolean
  Indicates whether the branch is cyclic or acyclic.

  Example: true
• isRestartCycle: boolean
  Indicates whether the branch cycle needs a restart of the cycle count.

  Example: true
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 32

  Visit branch short name.

  Example: Br2
• startCycle: integer (int32)
  Start cycle number.
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit branch title.

  Example: Branch 2

{
    "title":"VisitBranchDto v11.0",
    "required":[
        "isCycle",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit branch GUID.",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit branch title.",
            "example":"Branch 2"
        },
        "shortName":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Visit branch short name.",
            "example":"Br2"
        },
        "isCycle":{
            "type":"boolean",
            "description":"Indicates whether the branch is cyclic or acyclic.",
            "example":true
        },
        "cycleCount":{
            "type":"number",
            "description":"Number of times a branch can cycle.",
            "example":10
        },
        "branchTier":{
            "type":"integer",
            "description":"Tier information for the branch.",
            "format":"int32",
            "example":10
        },
        "branchIndex":{
            "type":"integer",
            "description":"Index information for the branch in the tier.",
            "format":"int32",
            "example":10
        },
        "arms":{
            "type":"array",
            "description":"Arm details.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "forms":{
            "type":"array",
            "description":"Form details.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "formVisits":{
            "type":"array",
            "description":"Visit details.",
            "example":[
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "startCycle":{
            "type":"integer",
            "description":"Start cycle number.",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"boolean",
            "description":"Indicates whether the branch cycle needs a restart of the cycle count.",
            "example":true
        }
    },
    "description":"Visit branch details.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "title":"Branch 2",
        "shortName":"Br2"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "title":"Branch 2",
    "shortName":"Br2"
}

Nested Schema : visits

Type: array

The visits in this branch.

Show Source

• Array of: object VisitDesignDto v11.0
  Title: VisitDesignDto v11.0

  Visit design information.

{
    "type":"array",
    "description":"The visits in this branch.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV11"
    }
}

Nested Schema : arms

Type: array

Arm details.

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Arm details.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : forms

Type: array

Form details.

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Form details.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : formVisits

Type: array

Visit details.

Show Source

• Array of: object From Item Advanced Property v11.0
  Title: From Item Advanced Property v11.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Visit details.",
    "example":[
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : From Item Advanced Property v11.0

Type: object

Title: From Item Advanced Property v11.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended Property ID
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
• value(required): string
  Minimum Length: 1

  Maximum Length: 2048

  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v11.0",
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov11"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object From Item Advanced Property Rule v11.0
  Title: From Item Advanced Property Rule v11.0

  Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v11.0

Type: object

Title: From Item Advanced Property Rule v11.0

Form Item Advanced Property Rule

Show Source

• label: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

  Example: Yes
• name: string
  name

  Example: RolloverQuestionAnswer
• value: string
  For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v11.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : VisitDesignDto v11.0

Type: object

Title: VisitDesignDto v11.0

Visit design information.

Show Source

• branchId: string (uuid)
  The ID of the branch.
• dispensings: object VisitDesignDispensingDto v11.0
  Title: VisitDesignDispensingDto v11.0

  Visit design dispensing properties.
• endVisitId: string (uuid)
  Visit design end visit ID.
• eventType: string
  Visit design event type.

  Example: ScreeningVisit
• forms: object VisitDesignAssignedFormsDto v11.0
  Title: VisitDesignAssignedFormsDto v11.0

  Visit design assigned forms properties.
• id: string (uuid)
  Visit design unique GUID.
• randomization: object VisitDesignRandomizationDto v11.0
  Title: VisitDesignRandomizationDto v11.0

  Visit design randomization properties.
• scheduling: object VisitDesignSchedulingDto v11.0
  Title: VisitDesignSchedulingDto v11.0

  Visit design scheduling properties.
• shortName: string
  Visit design short name.

  Example: Week1
• startVisitId: string (uuid)
  Visit design start visit ID.
• state: object VisitDesignStateDto v11.0
  Title: VisitDesignStateDto v11.0

  Visit design state properties.
• title: string
  Visit design title.

  Example: Week1

{
    "title":"VisitDesignDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit design unique GUID.",
            "format":"uuid"
        },
        "title":{
            "type":"string",
            "description":"Visit design title.",
            "example":"Week1"
        },
        "eventType":{
            "type":"string",
            "description":"Visit design event type.",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "type":"string",
            "description":"Visit design short name.",
            "example":"Week1"
        },
        "state":{
            "$ref":"#/components/schemas/VisitDesignStateDtoV11"
        },
        "scheduling":{
            "title":"VisitDesignSchedulingDto v11.0",
            "type":"object",
            "properties":{
                "fromVisitId":{
                    "type":"string",
                    "description":"Visit design from visit GUID.",
                    "format":"uuid"
                },
                "branchId":{
                    "type":"string",
                    "description":"Branch GUID.",
                    "format":"uuid"
                },
                "delay":{
                    "$ref":"#/components/schemas/Delay"
                },
                "beforeDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "afterDelayWindow":{
                    "$ref":"#/components/schemas/Delay"
                },
                "outOfWindowAlert":{
                    "type":"string",
                    "description":"Outside visit window alert.",
                    "format":"string",
                    "example":"OFF"
                }
            },
            "description":"Visit design scheduling properties.",
            "example":[
                {
                    "fromVisitId":"66C8628FB6594912B3214E294A5D4E9F",
                    "outOfWindowAlert":"OFF"
                }
            ]
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV11"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDTOV11"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV11"
        },
        "startVisitId":{
            "type":"string",
            "description":"Visit design start visit ID.",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"Visit design end visit ID.",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"The ID of the branch.",
            "format":"uuid"
        }
    },
    "description":"Visit design information.",
    "example":[
    ]
}

Nested Schema : VisitDesignDispensingDto v11.0

Type: object

Title: VisitDesignDispensingDto v11.0

Visit design dispensing properties.

Show Source

• advancedDispensationCount: integer (int32)
  Visit design advanced dispensation count.

  Example: 1
• deviceCount: integer (int32)
  Visit design device count.

  Example: 1
• id: integer (int32)
  Visit design titration count.

  Example: 1

{
    "title":"VisitDesignDispensingDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Visit design titration count.",
            "format":"int32",
            "example":1
        },
        "deviceCount":{
            "type":"integer",
            "description":"Visit design device count.",
            "format":"int32",
            "example":1
        },
        "advancedDispensationCount":{
            "type":"integer",
            "description":"Visit design advanced dispensation count.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design dispensing properties.",
    "example":{
        "count":1,
        "titrationCount":0,
        "deviceCount":0,
        "advancedDispensationCount":0
    }
}

Example:

{
    "count":1,
    "titrationCount":0,
    "deviceCount":0,
    "advancedDispensationCount":0
}

Nested Schema : VisitDesignAssignedFormsDto v11.0

Type: object

Title: VisitDesignAssignedFormsDto v11.0

Visit design assigned forms properties.

Show Source

• id: integer (int32)
  Visit design assigned forms count.

  Example: 1

{
    "title":"VisitDesignAssignedFormsDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Visit design assigned forms count.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design assigned forms properties.",
    "example":{
        "count":2
    }
}

Example:

{
    "count":2
}

Nested Schema : VisitDesignRandomizationDto v11.0

Type: object

Title: VisitDesignRandomizationDto v11.0

Visit design randomization properties.

Show Source

• algorithmType: string
  Visit design randomization algorithm type.

  Example: 1
• id: string (uuid)
  Visit design randomization unique GUID.
• treatmentArms: string
  Visit design randomization treatment arms to be remapped.

  Example: 1
• type: string
  Visit design randomization type.

  Example: 1
• visits: array visits
  Visit design randomization visit GUIDs.

{
    "title":"VisitDesignRandomizationDto v11.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit design randomization unique GUID.",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit design randomization type.",
            "example":"1"
        },
        "visits":{
            "type":"array",
            "description":"Visit design randomization visit GUIDs.",
            "example":[
                "55C8628FB6594912B3214E294A5D4E9F"
            ],
            "items":{
                "type":"string",
                "description":"Visit design randomization visit GUIDs.",
                "format":"uuid"
            }
        },
        "algorithmType":{
            "type":"string",
            "description":"Visit design randomization algorithm type.",
            "example":"1"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit design randomization treatment arms to be remapped.",
            "example":"1"
        }
    },
    "description":"Visit design randomization properties.",
    "example":{
        "id":"44C8628FB6594912B3214E294A5D4E9F",
        "type":"Blinded"
    }
}

Example:

{
    "id":"44C8628FB6594912B3214E294A5D4E9F",
    "type":"Blinded"
}

Nested Schema : VisitDesignSchedulingDto v11.0

Type: object

Title: VisitDesignSchedulingDto v11.0

Visit design scheduling properties.

Show Source

• afterDelayWindow: object Delay
  Visit design scheduling before-delay window
• beforeDelayWindow: object Delay
  Visit design scheduling before-delay window
• branchId: string (uuid)
  Branch GUID.
• delay: object Delay
  Visit design scheduling before-delay window
• fromVisitId: string (uuid)
  Visit design from visit GUID.
• outOfWindowAlert: string (string)
  Outside visit window alert.

  Example: OFF

{
    "title":"VisitDesignSchedulingDto v11.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit design from visit GUID.",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch GUID.",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/Delay"
        },
        "beforeDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/Delay"
        },
        "outOfWindowAlert":{
            "type":"string",
            "description":"Outside visit window alert.",
            "format":"string",
            "example":"OFF"
        }
    },
    "description":"Visit design scheduling properties.",
    "example":[
        {
            "fromVisitId":"66C8628FB6594912B3214E294A5D4E9F",
            "outOfWindowAlert":"OFF"
        }
    ]
}

Example:

[
    {
        "fromVisitId":"66C8628FB6594912B3214E294A5D4E9F",
        "outOfWindowAlert":"OFF"
    }
]

Nested Schema : VisitDesignStateDto v11.0

Type: object

Title: VisitDesignStateDto v11.0

Visit design state properties.

Show Source

• dynamic: boolean
  Visit design dynamic state.

  Example: false
• lastRequired: boolean
  Visit design last required state.

  Example: false
• nextVisitWithoutCompletion: boolean
  Indicates whether the next eligible visit can be started before this visit is complete. True and false apply to eligible Scheduled, Rescreening, and Screen Failure visits; null indicates the setting is not applicable.

  Example: false
• repeating: boolean
  Visit design repeating state.

  Example: false
• required: boolean
  Visit design required state.

  Example: true
• timeLine: integer (int32)
  Shows the visit in the timeline and lets the designer set when it can be shown to a user.

  Example: 1

{
    "title":"VisitDesignStateDto v11.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Visit design dynamic state.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Visit design repeating state.",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Visit design required state.",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Visit design last required state.",
            "example":false
        },
        "timeLine":{
            "type":"integer",
            "description":"Shows the visit in the timeline and lets the designer set when it can be shown to a user.",
            "format":"int32",
            "example":1
        },
        "nextVisitWithoutCompletion":{
            "type":"boolean",
            "description":"Indicates whether the next eligible visit can be started before this visit is complete. True and false apply to eligible Scheduled, Rescreening, and Screen Failure visits; null indicates the setting is not applicable.",
            "example":false
        }
    },
    "description":"Visit design state properties.",
    "example":{
        "dynamic":false,
        "repeating":false,
        "required":true,
        "lastRequired":false,
        "timeLine":1
    }
}

Example:

{
    "dynamic":false,
    "repeating":false,
    "required":true,
    "lastRequired":false,
    "timeLine":1
}

Nested Schema : visits

Type: array

Visit design randomization visit GUIDs.

Show Source

• Array of: string(uuid)
  Visit design randomization visit GUIDs.

{
    "type":"array",
    "description":"Visit design randomization visit GUIDs.",
    "example":[
        "55C8628FB6594912B3214E294A5D4E9F"
    ],
    "items":{
        "type":"string",
        "description":"Visit design randomization visit GUIDs.",
        "format":"uuid"
    }
}

Example:

[
    "55C8628FB6594912B3214E294A5D4E9F"
]

Nested Schema : Delay

Type: object

Visit design scheduling before-delay window

Show Source

• days: integer (int32)
  Minimum Value: 0

  Maximum Value: 365
• hours: integer (int32)
  Minimum Value: 0

  Maximum Value: 24

{
    "type":"object",
    "properties":{
        "days":{
            "maximum":365,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "maximum":24,
            "minimum":0,
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Visit design scheduling before-delay window"
}

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

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top