Jump to

• Request
• Response

[Deprecated]: V4.0

get

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

Deprecated: Use latest version instead. Retrieves list of visits in a study's design.

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 : schema

Type: array

Show Source

• Array of: object Visit Design DTO V4
  Visit Design properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Visit Design DTO V4"
    }
}

Nested Schema : Visit Design DTO V4

Type: object

Visit Design properties

Show Source

• eventType: string
  Visit Design event type

  Example: ScreeningVisit
• id: string (uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string)
• shortName: string
  Visit Design short name

  Example: Week1
• state: object Visit Design Dispensing DTO V4
  Visit Design dispensing properties
• title: string
  Visit Design title

  Example: Week1

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string)",
            "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/Visit Design Dispensing DTO V4"
        }
    },
    "description":"Visit Design properties"
}

Nested Schema : Visit Design Dispensing DTO V4

Type: object

Visit Design dispensing properties

Show Source

• count: integer (int32)
  Number of dispensation assignments for this visit

  Example: 1
• deviceCount: integer (int32)
  Number of device dispensation assignments for this visit

  Example: 1
• titrationCount: integer (int32)
  Number of titration assignments for this visit

  Example: 1

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of dispensation assignments for this visit",
            "format":"int32",
            "example":1
        },
        "titrationCount":{
            "type":"integer",
            "description":"Number of titration assignments for this visit",
            "format":"int32",
            "example":1
        },
        "deviceCount":{
            "type":"integer",
            "description":"Number of device dispensation assignments for this visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design dispensing properties"
}

Examples

Select an example successResponse

204 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Visit Design DTO V4
  Visit Design properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Visit Design DTO V4"
    }
}

Nested Schema : Visit Design DTO V4

Type: object

Visit Design properties

Show Source

• eventType: string
  Visit Design event type

  Example: ScreeningVisit
• id: string (uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string)
• shortName: string
  Visit Design short name

  Example: Week1
• state: object Visit Design Dispensing DTO V4
  Visit Design dispensing properties
• title: string
  Visit Design title

  Example: Week1

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string)",
            "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/Visit Design Dispensing DTO V4"
        }
    },
    "description":"Visit Design properties"
}

Nested Schema : Visit Design Dispensing DTO V4

Type: object

Visit Design dispensing properties

Show Source

• count: integer (int32)
  Number of dispensation assignments for this visit

  Example: 1
• deviceCount: integer (int32)
  Number of device dispensation assignments for this visit

  Example: 1
• titrationCount: integer (int32)
  Number of titration assignments for this visit

  Example: 1

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of dispensation assignments for this visit",
            "format":"int32",
            "example":1
        },
        "titrationCount":{
            "type":"integer",
            "description":"Number of titration assignments for this visit",
            "format":"int32",
            "example":1
        },
        "deviceCount":{
            "type":"integer",
            "description":"Number of device dispensation assignments for this visit",
            "format":"int32",
            "example":1
        }
    },
    "description":"Visit Design dispensing properties"
}

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