REST API for Clinical One Platform

Create study design visits for multiple versions

post

/ec-designer-svc/rest/v9.0/studies/{studyId}/design

Creates list of visits for multiple versions in a study's design.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

isLiteAPI: boolean

If true, generate light version of the API.

Default Value: true

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: string

Example: 1.0.0.1

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"1.0.0.1"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object VisitBranchDesignDtoV9

Visit Design branches

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

Nested Schema : VisitBranchDesignDtoV9

Type: object

Visit Design branches

Show Source

branchVisits: array branchVisits

branches
scheduledVisits: array scheduledVisits

scheduledVisits
unscheduledVisits: array unscheduledVisits

unscheduledVisits

{
    "type":"object",
    "properties":{
        "scheduledVisits":{
            "type":"array",
            "description":"scheduledVisits",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV9"
            }
        },
        "branchVisits":{
            "type":"array",
            "description":"branches",
            "items":{
                "type":"array",
                "description":"branches",
                "items":{
                    "$ref":"#/components/schemas/BranchDesignDTOV9"
                }
            }
        },
        "unscheduledVisits":{
            "type":"array",
            "description":"unscheduledVisits",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV9"
            }
        }
    },
    "description":"Visit Design branches"
}

Nested Schema : branchVisits

Type: array

branches

Show Source

Array of: array items

branches

{
    "type":"array",
    "description":"branches",
    "items":{
        "type":"array",
        "description":"branches",
        "items":{
            "$ref":"#/components/schemas/BranchDesignDTOV9"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

scheduledVisits

Show Source

Array of: object VisitDesignDto v9.0

Title: VisitDesignDto v9.0

Visit Design Information

{
    "type":"array",
    "description":"scheduledVisits",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV9"
    }
}

Nested Schema : unscheduledVisits

Type: array

unscheduledVisits

Show Source

Array of: object VisitDesignDto v9.0

Title: VisitDesignDto v9.0

Visit Design Information

{
    "type":"array",
    "description":"unscheduledVisits",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV9"
    }
}

Nested Schema : items

Type: array

branches

Show Source

Array of: object BranchDesignDTOV9

Branch Design properties

{
    "type":"array",
    "description":"branches",
    "items":{
        "$ref":"#/components/schemas/BranchDesignDTOV9"
    }
}

Nested Schema : BranchDesignDTOV9

Type: object

Branch Design properties

Show Source

branch: object VisitBranchDto v2.0

Title: VisitBranchDto v2.0

Visit Branch details.
visits: array visits

The visits in this branch

{
    "type":"object",
    "properties":{
        "branch":{
            "$ref":"#/components/schemas/VisitBranchDtoV2"
        },
        "visits":{
            "type":"array",
            "description":"The visits in this branch",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV9"
            }
        }
    },
    "description":"Branch Design properties"
}

Nested Schema : VisitBranchDto v2.0

Type: object

Title: VisitBranchDto v2.0

Visit Branch details.

Show Source

arms: array arms

Arm Details DTO
branchIndex: integer (int32)

index information of the branch in the tier

Example: 10
branchTier: integer (int32)

tier information of the branch

Example: 10
cycleCount: number

number of times a branch can cycle

Example: 10
forms: array forms

Form Details DTO
formVisits: array formVisits

Visit Details DTO
id: string (uuid)

Visit Branch GUID
isCycle(required): boolean

determines if the branch is cyclic or acyclic

Example: true
isRestartCycle: boolean

determines if the branch is cycles needs a restart of the cycle count

Example: true
shortName(required): string

Minimum Length: 1

Maximum Length: 32

Visit Branch shortName

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 v2.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 shortName",
            "example":"Br2"
        },
        "isCycle":{
            "type":"boolean",
            "description":"determines if 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 of the branch",
            "format":"int32",
            "example":10
        },
        "branchIndex":{
            "type":"integer",
            "description":"index information of the branch in the tier",
            "format":"int32",
            "example":10
        },
        "arms":{
            "type":"array",
            "description":"Arm Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "forms":{
            "type":"array",
            "description":"Form Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "formVisits":{
            "type":"array",
            "description":"Visit Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "startCycle":{
            "type":"integer",
            "description":"Start Cycle Number",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"boolean",
            "description":"determines if the branch is cycles needs a restart of the cycle count",
            "example":true
        }
    },
    "description":"Visit Branch details."
}

Nested Schema : visits

Type: array

The visits in this branch

Show Source

Array of: object VisitDesignDto v9.0

Title: VisitDesignDto v9.0

Visit Design Information

{
    "type":"array",
    "description":"The visits in this branch",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV9"
    }
}

Nested Schema : arms

Type: array

Arm Details DTO

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 DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : forms

Type: array

Form Details DTO

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 DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : formVisits

Type: array

Visit Details DTO

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 DTO",
    "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 v9.0

Type: object

Title: VisitDesignDto v9.0

Visit Design Information

Show Source

branchId: string (uuid)

The id of the branch
dispensings: object VisitDesignDispensingDto v9.0

Title: VisitDesignDispensingDto v9.0

Visit Design dispensing properties
endVisitId: string (uuid)

Visit design End Visit Id
eventType: string

Visit Design event type

Example: ScreeningVisit
forms: object VisitDesignAssignedFormsDto v9.0

Title: VisitDesignAssignedFormsDto v9.0

Visit Design assigned forms properties
id: string (uuid)

Visit Design unique GUID
randomization: object VisitDesignRandomizationDto v9.0

Title: VisitDesignRandomizationDto v9.0

Visit Design randomization properties
scheduling: object VisitDesignSchedulingDto v9.0

Title: VisitDesignSchedulingDto v9.0

Visit Design scheduling properties
shortName: string

Visit Design short name

Example: Week1
startVisitId: string (uuid)

Visit Design Start Visit Id
state: object VisitDesignStateDto v9.0

Title: VisitDesignStateDto v9.0

Visit Design state properties
title: string

Visit design title

Example: Week1

{
    "title":"VisitDesignDto v9.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/VisitDesignStateDtoV8"
        },
        "scheduling":{
            "title":"VisitDesignSchedulingDto v9.0",
            "type":"object",
            "properties":{
                "fromVisitId":{
                    "type":"string",
                    "description":"Visit Design from visit GUID",
                    "format":"uuid"
                },
                "branchId":{
                    "type":"string",
                    "description":"bbranch 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"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV8"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDTOV9"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV9"
        },
        "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"
}

Nested Schema : VisitDesignDispensingDto v9.0

Type: object

Title: VisitDesignDispensingDto v9.0

Visit Design dispensing properties

Show Source

deviceCount: integer (int32)

Visit Design device count

Example: 1
id: integer (int32)

Visit Design titration count

Example: 1

{
    "title":"VisitDesignDispensingDto v9.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
        }
    },
    "description":"Visit Design dispensing properties"
}

Nested Schema : VisitDesignAssignedFormsDto v9.0

Type: object

Title: VisitDesignAssignedFormsDto v9.0

Visit Design assigned forms properties

Show Source

id: integer (int32)

Visit Design assigned forms count

Example: 1

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

Nested Schema : VisitDesignRandomizationDto v9.0

Type: object

Title: VisitDesignRandomizationDto v9.0

Visit Design randomization properties

Show Source

algorithmType: string

Visit Design allow randomization algorithm type

Example: 1
id: string (uuid)

Visit Design randomization unique GUID
treatmentArms: string

Visit Design allow randomization treatment arms to be remapped

Example: 1
type: string

Visit Design randomization type

Example: 1
visits: array visits

Visit Design randomization visit GUID's

{
    "title":"VisitDesignRandomizationDto v9.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 GUID's",
            "example":"55C8628FB6594912B3214E294A5D4E9F",
            "items":{
                "type":"string",
                "description":"Visit Design randomization visit GUID's",
                "format":"uuid"
            }
        },
        "algorithmType":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"1"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"1"
        }
    },
    "description":"Visit Design randomization properties"
}

Nested Schema : VisitDesignSchedulingDto v9.0

Type: object

Title: VisitDesignSchedulingDto v9.0

Visit Design scheduling properties

Show Source

afterDelayWindow: object Delay

Visit Design cheduing before delay
beforeDelayWindow: object Delay

Visit Design cheduing before delay
branchId: string (uuid)

bbranch GUID
delay: object Delay

Visit Design cheduing before delay
fromVisitId: string (uuid)

Visit Design from visit GUID
outOfWindowAlert: string (string)

Outside Visit Window Alert

Example: OFF

{
    "title":"VisitDesignSchedulingDto v9.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit Design from visit GUID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"bbranch 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"
}

Nested Schema : VisitDesignStateDto v9.0

Type: object

Title: VisitDesignStateDto v9.0

Visit Design state properties

Show Source

dynamic: boolean

Visit Design dynamic state

Example: false
lastRequired: boolean

Visit Design lastRequired state

Example: false
repeating: boolean

Visit Design repeating state

Example: false
required: boolean

Visit Design required state

Example: true
timeLine: integer (int32)

show in timeline. allows the designer to set when a visit can be shown to a user.

Example: 1

{
    "title":"VisitDesignStateDto v9.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 lastRequired state",
            "example":false
        },
        "timeLine":{
            "type":"integer",
            "description":"show in timeline. allows the designer to set when a visit can be shown to a user.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design state properties"
}

Nested Schema : visits

Type: array

Visit Design randomization visit GUID's

Show Source

Array of: string(uuid)

Visit Design randomization visit GUID's

{
    "type":"array",
    "description":"Visit Design randomization visit GUID's",
    "example":"55C8628FB6594912B3214E294A5D4E9F",
    "items":{
        "type":"string",
        "description":"Visit Design randomization visit GUID's",
        "format":"uuid"
    }
}

Example:

55C8628FB6594912B3214E294A5D4E9F

Nested Schema : Delay

Type: object

Visit Design cheduing before delay

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 cheduing before delay"
}

204 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object VisitBranchDesignDtoV9

Visit Design branches

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

Nested Schema : VisitBranchDesignDtoV9

Type: object

Visit Design branches

Show Source

branchVisits: array branchVisits

branches
scheduledVisits: array scheduledVisits

scheduledVisits
unscheduledVisits: array unscheduledVisits

unscheduledVisits

{
    "type":"object",
    "properties":{
        "scheduledVisits":{
            "type":"array",
            "description":"scheduledVisits",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV9"
            }
        },
        "branchVisits":{
            "type":"array",
            "description":"branches",
            "items":{
                "type":"array",
                "description":"branches",
                "items":{
                    "$ref":"#/components/schemas/BranchDesignDTOV9"
                }
            }
        },
        "unscheduledVisits":{
            "type":"array",
            "description":"unscheduledVisits",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV9"
            }
        }
    },
    "description":"Visit Design branches"
}

Nested Schema : branchVisits

Type: array

branches

Show Source

Array of: array items

branches

{
    "type":"array",
    "description":"branches",
    "items":{
        "type":"array",
        "description":"branches",
        "items":{
            "$ref":"#/components/schemas/BranchDesignDTOV9"
        }
    }
}

Nested Schema : scheduledVisits

Type: array

scheduledVisits

Show Source

Array of: object VisitDesignDto v9.0

Title: VisitDesignDto v9.0

Visit Design Information

{
    "type":"array",
    "description":"scheduledVisits",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV9"
    }
}

Nested Schema : unscheduledVisits

Type: array

unscheduledVisits

Show Source

Array of: object VisitDesignDto v9.0

Title: VisitDesignDto v9.0

Visit Design Information

{
    "type":"array",
    "description":"unscheduledVisits",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV9"
    }
}

Nested Schema : items

Type: array

branches

Show Source

Array of: object BranchDesignDTOV9

Branch Design properties

{
    "type":"array",
    "description":"branches",
    "items":{
        "$ref":"#/components/schemas/BranchDesignDTOV9"
    }
}

Nested Schema : BranchDesignDTOV9

Type: object

Branch Design properties

Show Source

branch: object VisitBranchDto v2.0

Title: VisitBranchDto v2.0

Visit Branch details.
visits: array visits

The visits in this branch

{
    "type":"object",
    "properties":{
        "branch":{
            "$ref":"#/components/schemas/VisitBranchDtoV2"
        },
        "visits":{
            "type":"array",
            "description":"The visits in this branch",
            "items":{
                "$ref":"#/components/schemas/VisitDesignDtoV9"
            }
        }
    },
    "description":"Branch Design properties"
}

Nested Schema : VisitBranchDto v2.0

Type: object

Title: VisitBranchDto v2.0

Visit Branch details.

Show Source

arms: array arms

Arm Details DTO
branchIndex: integer (int32)

index information of the branch in the tier

Example: 10
branchTier: integer (int32)

tier information of the branch

Example: 10
cycleCount: number

number of times a branch can cycle

Example: 10
forms: array forms

Form Details DTO
formVisits: array formVisits

Visit Details DTO
id: string (uuid)

Visit Branch GUID
isCycle(required): boolean

determines if the branch is cyclic or acyclic

Example: true
isRestartCycle: boolean

determines if the branch is cycles needs a restart of the cycle count

Example: true
shortName(required): string

Minimum Length: 1

Maximum Length: 32

Visit Branch shortName

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 v2.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 shortName",
            "example":"Br2"
        },
        "isCycle":{
            "type":"boolean",
            "description":"determines if 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 of the branch",
            "format":"int32",
            "example":10
        },
        "branchIndex":{
            "type":"integer",
            "description":"index information of the branch in the tier",
            "format":"int32",
            "example":10
        },
        "arms":{
            "type":"array",
            "description":"Arm Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "forms":{
            "type":"array",
            "description":"Form Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "formVisits":{
            "type":"array",
            "description":"Visit Details DTO",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
            }
        },
        "startCycle":{
            "type":"integer",
            "description":"Start Cycle Number",
            "format":"int32"
        },
        "isRestartCycle":{
            "type":"boolean",
            "description":"determines if the branch is cycles needs a restart of the cycle count",
            "example":true
        }
    },
    "description":"Visit Branch details."
}

Nested Schema : visits

Type: array

The visits in this branch

Show Source

Array of: object VisitDesignDto v9.0

Title: VisitDesignDto v9.0

Visit Design Information

{
    "type":"array",
    "description":"The visits in this branch",
    "items":{
        "$ref":"#/components/schemas/VisitDesignDtoV9"
    }
}

Nested Schema : arms

Type: array

Arm Details DTO

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 DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : forms

Type: array

Form Details DTO

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 DTO",
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov11"
    }
}

Nested Schema : formVisits

Type: array

Visit Details DTO

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 DTO",
    "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 v9.0

Type: object

Title: VisitDesignDto v9.0

Visit Design Information

Show Source

branchId: string (uuid)

The id of the branch
dispensings: object VisitDesignDispensingDto v9.0

Title: VisitDesignDispensingDto v9.0

Visit Design dispensing properties
endVisitId: string (uuid)

Visit design End Visit Id
eventType: string

Visit Design event type

Example: ScreeningVisit
forms: object VisitDesignAssignedFormsDto v9.0

Title: VisitDesignAssignedFormsDto v9.0

Visit Design assigned forms properties
id: string (uuid)

Visit Design unique GUID
randomization: object VisitDesignRandomizationDto v9.0

Title: VisitDesignRandomizationDto v9.0

Visit Design randomization properties
scheduling: object VisitDesignSchedulingDto v9.0

Title: VisitDesignSchedulingDto v9.0

Visit Design scheduling properties
shortName: string

Visit Design short name

Example: Week1
startVisitId: string (uuid)

Visit Design Start Visit Id
state: object VisitDesignStateDto v9.0

Title: VisitDesignStateDto v9.0

Visit Design state properties
title: string

Visit design title

Example: Week1

{
    "title":"VisitDesignDto v9.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/VisitDesignStateDtoV8"
        },
        "scheduling":{
            "title":"VisitDesignSchedulingDto v9.0",
            "type":"object",
            "properties":{
                "fromVisitId":{
                    "type":"string",
                    "description":"Visit Design from visit GUID",
                    "format":"uuid"
                },
                "branchId":{
                    "type":"string",
                    "description":"bbranch 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"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV8"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDTOV9"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV9"
        },
        "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"
}

Nested Schema : VisitDesignDispensingDto v9.0

Type: object

Title: VisitDesignDispensingDto v9.0

Visit Design dispensing properties

Show Source

deviceCount: integer (int32)

Visit Design device count

Example: 1
id: integer (int32)

Visit Design titration count

Example: 1

{
    "title":"VisitDesignDispensingDto v9.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
        }
    },
    "description":"Visit Design dispensing properties"
}

Nested Schema : VisitDesignAssignedFormsDto v9.0

Type: object

Title: VisitDesignAssignedFormsDto v9.0

Visit Design assigned forms properties

Show Source

id: integer (int32)

Visit Design assigned forms count

Example: 1

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

Nested Schema : VisitDesignRandomizationDto v9.0

Type: object

Title: VisitDesignRandomizationDto v9.0

Visit Design randomization properties

Show Source

algorithmType: string

Visit Design allow randomization algorithm type

Example: 1
id: string (uuid)

Visit Design randomization unique GUID
treatmentArms: string

Visit Design allow randomization treatment arms to be remapped

Example: 1
type: string

Visit Design randomization type

Example: 1
visits: array visits

Visit Design randomization visit GUID's

{
    "title":"VisitDesignRandomizationDto v9.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 GUID's",
            "example":"55C8628FB6594912B3214E294A5D4E9F",
            "items":{
                "type":"string",
                "description":"Visit Design randomization visit GUID's",
                "format":"uuid"
            }
        },
        "algorithmType":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"1"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"1"
        }
    },
    "description":"Visit Design randomization properties"
}

Nested Schema : VisitDesignSchedulingDto v9.0

Type: object

Title: VisitDesignSchedulingDto v9.0

Visit Design scheduling properties

Show Source

afterDelayWindow: object Delay

Visit Design cheduing before delay
beforeDelayWindow: object Delay

Visit Design cheduing before delay
branchId: string (uuid)

bbranch GUID
delay: object Delay

Visit Design cheduing before delay
fromVisitId: string (uuid)

Visit Design from visit GUID
outOfWindowAlert: string (string)

Outside Visit Window Alert

Example: OFF

{
    "title":"VisitDesignSchedulingDto v9.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit Design from visit GUID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"bbranch 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"
}

Nested Schema : VisitDesignStateDto v9.0

Type: object

Title: VisitDesignStateDto v9.0

Visit Design state properties

Show Source

dynamic: boolean

Visit Design dynamic state

Example: false
lastRequired: boolean

Visit Design lastRequired state

Example: false
repeating: boolean

Visit Design repeating state

Example: false
required: boolean

Visit Design required state

Example: true
timeLine: integer (int32)

show in timeline. allows the designer to set when a visit can be shown to a user.

Example: 1

{
    "title":"VisitDesignStateDto v9.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 lastRequired state",
            "example":false
        },
        "timeLine":{
            "type":"integer",
            "description":"show in timeline. allows the designer to set when a visit can be shown to a user.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design state properties"
}

Nested Schema : visits

Type: array

Visit Design randomization visit GUID's

Show Source

Array of: string(uuid)

Visit Design randomization visit GUID's

{
    "type":"array",
    "description":"Visit Design randomization visit GUID's",
    "example":"55C8628FB6594912B3214E294A5D4E9F",
    "items":{
        "type":"string",
        "description":"Visit Design randomization visit GUID's",
        "format":"uuid"
    }
}

Example:

55C8628FB6594912B3214E294A5D4E9F

Nested Schema : Delay

Type: object

Visit Design cheduing before delay

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 cheduing before delay"
}

500 Response

Error

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