Jump to

• Request
• Response

[Deprecated]: V1.0

put

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

Deprecated: Use latest version instead. Updates a visit in your study.

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

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

  Example:

  9F4A6C7E1B8F4D56A23C9F3A0C7D4E77

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : VisitDto v1.0

Type: object

Title: VisitDto v1.0

Visit design.

Show Source

• id: string (uuid)
  Visit GUID
• randomization: string (uuid)
  Randomization GUID
• repeatNumber(required): integer (int32)
  Times to repeat Visit Design.

  Example: 5
• repeatVisit(required): boolean
  Yes - if Visit Design is repeating.

  Example: false
• requiredVisit(required): boolean
  Yes - if Visit Design is required.

  Example: false
• screeningVisit(required): boolean
  Yes - if Visit Design is screening.

  Example: false
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit title

  Example: Week 2

{
    "title":"VisitDto v1.0",
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "screeningVisit",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit title",
            "example":"Week 2"
        },
        "repeatVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating.",
            "example":false
        },
        "repeatNumber":{
            "type":"integer",
            "description":"Times to repeat Visit Design.",
            "format":"int32",
            "example":5
        },
        "screeningVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is screening.",
            "example":false
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        }
    },
    "description":"Visit design."
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

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

  Visit design.

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

Nested Schema : VisitDto v1.0

Type: object

Title: VisitDto v1.0

Visit design.

Show Source

• id: string (uuid)
  Visit GUID
• randomization: string (uuid)
  Randomization GUID
• repeatNumber(required): integer (int32)
  Times to repeat Visit Design.

  Example: 5
• repeatVisit(required): boolean
  Yes - if Visit Design is repeating.

  Example: false
• requiredVisit(required): boolean
  Yes - if Visit Design is required.

  Example: false
• screeningVisit(required): boolean
  Yes - if Visit Design is screening.

  Example: false
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit title

  Example: Week 2

{
    "title":"VisitDto v1.0",
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "screeningVisit",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit title",
            "example":"Week 2"
        },
        "repeatVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating.",
            "example":false
        },
        "repeatNumber":{
            "type":"integer",
            "description":"Times to repeat Visit Design.",
            "format":"int32",
            "example":5
        },
        "screeningVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is screening.",
            "example":false
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        }
    },
    "description":"Visit design."
}

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