Jump to

• Request
• Response

V1.0

get

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

Retrieves visit design assignments for the study version. Use the latest supported visit design endpoint in v17.0 for current behavior.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

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

  Example:

  1.0.0.1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Visit Design Information

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

Nested Schema : VisitDesignDto v1.0

Type: object

Title: VisitDesignDto v1.0

Visit Design Information

Show Source

• dispensings: object VisitDesignDispensingDto v1.0
  Title: VisitDesignDispensingDto v1.0

  Visit design dispensings.
• eventType: string
  Visit Design event type

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

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

  Visit design randomization.
• scheduling: object VisitDesignSchedulingDto v1.0
  Title: VisitDesignSchedulingDto v1.0

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

  Example: Week1
• state: object VisitDesignStateDto v1.0
  Title: VisitDesignStateDto v1.0

  Visit design state.
• title: string
  Visit design title

  Example: Week1

{
    "title":"VisitDesignDto v1.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/VisitDesignStateDtoV1"
        },
        "scheduling":{
            "$ref":"#/components/schemas/VisitDesignSchedulingDtoV1"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV1"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDtoV1"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV1"
        }
    },
    "description":"Visit Design Information"
}

Nested Schema : VisitDesignDispensingDto v1.0

Type: object

Title: VisitDesignDispensingDto v1.0

Visit design dispensings.

Show Source

• count: integer (int32)
  Visit Design dispensing count

  Example: 1

{
    "title":"VisitDesignDispensingDto v1.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Visit Design dispensing count",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design dispensings."
}

Nested Schema : VisitDesignAssignedFormsDto v1.0

Type: object

Title: VisitDesignAssignedFormsDto v1.0

Visit design assigned forms.

Show Source

• count: integer (int32)
  Count of the forms assigned to the visit

  Example: 1

{
    "title":"VisitDesignAssignedFormsDto v1.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Count of the forms assigned to the visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design assigned forms."
}

Nested Schema : VisitDesignRandomizationDto v1.0

Type: object

Title: VisitDesignRandomizationDto v1.0

Visit design randomization.

Show Source

• algorithm: string
  Visit Design allow randomization algorithm type

  Example: Central
• id: string (uuid)
  Visit Design randomization unique GUID
• treatmentArms: string
  Visit Design allow randomization treatment arms to be remapped

  Example: 9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:
• type: string
  Visit Design randomization type

  Example: Blinded
• visits: array visits

{
    "title":"VisitDesignRandomizationDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Design randomization unique GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit Design randomization type",
            "example":"Blinded"
        },
        "algorithm":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"Central"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:"
        },
        "visits":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Visit Design randomization visit GUID's",
                "format":"uuid"
            }
        }
    },
    "description":"Visit design randomization."
}

Nested Schema : VisitDesignSchedulingDto v1.0

Type: object

Title: VisitDesignSchedulingDto v1.0

Visit design scheduling.

Show Source

• afterDelayWindow: object Delay v1.0
  Title: Delay v1.0

  Schedule delay in days/hours.
• beforeDelayWindow: object Delay v1.0
  Title: Delay v1.0

  Schedule delay in days/hours.
• delay: object Delay v1.0
  Title: Delay v1.0

  Schedule delay in days/hours.
• fromVisitId: string (uuid)
  Visit Design : scheduled from visit GUID

{
    "title":"VisitDesignSchedulingDto v1.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit Design : scheduled from visit GUID",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/DelayV1"
        },
        "beforeDelayWindow":{
            "$ref":"#/components/schemas/DelayV1"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/DelayV1"
        }
    },
    "description":"Visit design scheduling."
}

Nested Schema : VisitDesignStateDto v1.0

Type: object

Title: VisitDesignStateDto v1.0

Visit design state.

Show Source

• dynamic: boolean
  Yes - if Visit Design dynamic state.

  Example: false
• lastRequired: boolean
  Yes - if Visit Design is last required state.

  Example: false
• repeating: boolean
  Yes - if Visit Design is repeating state.

  Example: false
• required: boolean
  Yes - if Visit Design is required state.

  Example: true

{
    "title":"VisitDesignStateDto v1.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Yes - if Visit Design dynamic state.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating state.",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required state.",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit Design is last required state.",
            "example":false
        }
    },
    "description":"Visit design state."
}

Nested Schema : visits

Type: array

Show Source

• Array of: string(uuid)
  Visit Design randomization visit GUID's

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

Nested Schema : Delay v1.0

Type: object

Title: Delay v1.0

Schedule delay in days/hours.

Show Source

• days: integer (int32)
• hours: integer (int32)

{
    "title":"Delay v1.0",
    "type":"object",
    "properties":{
        "days":{
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Schedule delay in days/hours."
}

Examples

Select an example getVisitDesignV1Response

204 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Visit Design Information

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

Nested Schema : VisitDesignDto v1.0

Type: object

Title: VisitDesignDto v1.0

Visit Design Information

Show Source

• dispensings: object VisitDesignDispensingDto v1.0
  Title: VisitDesignDispensingDto v1.0

  Visit design dispensings.
• eventType: string
  Visit Design event type

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

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

  Visit design randomization.
• scheduling: object VisitDesignSchedulingDto v1.0
  Title: VisitDesignSchedulingDto v1.0

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

  Example: Week1
• state: object VisitDesignStateDto v1.0
  Title: VisitDesignStateDto v1.0

  Visit design state.
• title: string
  Visit design title

  Example: Week1

{
    "title":"VisitDesignDto v1.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/VisitDesignStateDtoV1"
        },
        "scheduling":{
            "$ref":"#/components/schemas/VisitDesignSchedulingDtoV1"
        },
        "randomization":{
            "$ref":"#/components/schemas/VisitDesignRandomizationDtoV1"
        },
        "forms":{
            "$ref":"#/components/schemas/VisitDesignAssignedFormsDtoV1"
        },
        "dispensings":{
            "$ref":"#/components/schemas/VisitDesignDispensingDtoV1"
        }
    },
    "description":"Visit Design Information"
}

Nested Schema : VisitDesignDispensingDto v1.0

Type: object

Title: VisitDesignDispensingDto v1.0

Visit design dispensings.

Show Source

• count: integer (int32)
  Visit Design dispensing count

  Example: 1

{
    "title":"VisitDesignDispensingDto v1.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Visit Design dispensing count",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design dispensings."
}

Nested Schema : VisitDesignAssignedFormsDto v1.0

Type: object

Title: VisitDesignAssignedFormsDto v1.0

Visit design assigned forms.

Show Source

• count: integer (int32)
  Count of the forms assigned to the visit

  Example: 1

{
    "title":"VisitDesignAssignedFormsDto v1.0",
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Count of the forms assigned to the visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit design assigned forms."
}

Nested Schema : VisitDesignRandomizationDto v1.0

Type: object

Title: VisitDesignRandomizationDto v1.0

Visit design randomization.

Show Source

• algorithm: string
  Visit Design allow randomization algorithm type

  Example: Central
• id: string (uuid)
  Visit Design randomization unique GUID
• treatmentArms: string
  Visit Design allow randomization treatment arms to be remapped

  Example: 9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:
• type: string
  Visit Design randomization type

  Example: Blinded
• visits: array visits

{
    "title":"VisitDesignRandomizationDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit Design randomization unique GUID",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Visit Design randomization type",
            "example":"Blinded"
        },
        "algorithm":{
            "type":"string",
            "description":"Visit Design allow randomization algorithm type",
            "example":"Central"
        },
        "treatmentArms":{
            "type":"string",
            "description":"Visit Design allow randomization treatment arms to be remapped",
            "example":"9872E220DD074DD3B463143DAAA684DC:,9872E220DD074DD3B463143DAAA684DC:"
        },
        "visits":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Visit Design randomization visit GUID's",
                "format":"uuid"
            }
        }
    },
    "description":"Visit design randomization."
}

Nested Schema : VisitDesignSchedulingDto v1.0

Type: object

Title: VisitDesignSchedulingDto v1.0

Visit design scheduling.

Show Source

• afterDelayWindow: object Delay v1.0
  Title: Delay v1.0

  Schedule delay in days/hours.
• beforeDelayWindow: object Delay v1.0
  Title: Delay v1.0

  Schedule delay in days/hours.
• delay: object Delay v1.0
  Title: Delay v1.0

  Schedule delay in days/hours.
• fromVisitId: string (uuid)
  Visit Design : scheduled from visit GUID

{
    "title":"VisitDesignSchedulingDto v1.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Visit Design : scheduled from visit GUID",
            "format":"uuid"
        },
        "delay":{
            "$ref":"#/components/schemas/DelayV1"
        },
        "beforeDelayWindow":{
            "$ref":"#/components/schemas/DelayV1"
        },
        "afterDelayWindow":{
            "$ref":"#/components/schemas/DelayV1"
        }
    },
    "description":"Visit design scheduling."
}

Nested Schema : VisitDesignStateDto v1.0

Type: object

Title: VisitDesignStateDto v1.0

Visit design state.

Show Source

• dynamic: boolean
  Yes - if Visit Design dynamic state.

  Example: false
• lastRequired: boolean
  Yes - if Visit Design is last required state.

  Example: false
• repeating: boolean
  Yes - if Visit Design is repeating state.

  Example: false
• required: boolean
  Yes - if Visit Design is required state.

  Example: true

{
    "title":"VisitDesignStateDto v1.0",
    "type":"object",
    "properties":{
        "dynamic":{
            "type":"boolean",
            "description":"Yes - if Visit Design dynamic state.",
            "example":false
        },
        "repeating":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating state.",
            "example":false
        },
        "required":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required state.",
            "example":true
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit Design is last required state.",
            "example":false
        }
    },
    "description":"Visit design state."
}

Nested Schema : visits

Type: array

Show Source

• Array of: string(uuid)
  Visit Design randomization visit GUID's

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

Nested Schema : Delay v1.0

Type: object

Title: Delay v1.0

Schedule delay in days/hours.

Show Source

• days: integer (int32)
• hours: integer (int32)

{
    "title":"Delay v1.0",
    "type":"object",
    "properties":{
        "days":{
            "type":"integer",
            "format":"int32"
        },
        "hours":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Schedule delay in days/hours."
}

Examples

Select an example successResponse

500 Response

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

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

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

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

Nested Schema : details

Type: object

Back to Top