Jump to

• Request
• Response

Update a visit

put

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

Updates a visit in your study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"
• visitid(required): string(uuid)

Supported Media Types

• */*

Request Body - */* ()

Root Schema : VisitDto v6.0

Type: object

Title: VisitDto v6.0

Visit design.

Show Source

• branchId: string (uuid)
  Branch Id
• endVisitId: string (uuid)
  End visit ID
• eventType: string
  Visit event type

  Example: ScreeningVisit
• id: string (uuid)
  Visit GUID
• lastRequired: boolean
  Yes - if Visit is last required.

  Example: false
• 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
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 16

  Pattern: [a-zA-Z0-9]+

  Visit short name

  Example: Week1
• startVisitId: string (uuid)
  Start visit ID
• studyVersion: string
  Study version

  Example: 1.0.0.1
• studyVersionStatus: string
  Study version status

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

  Maximum Length: 64

  Visit title

  Example: Week 2
• visitDescription: string
  Visit description

  Example: Regular 2 week visit
• visitStartDate: string (date-time)
  Visit start date time

  Example: 2019-01-25T07:42:00.204Z

{
    "title":"VisitDto v6.0",
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "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"
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit is last required.",
            "example":false
        },
        "eventType":{
            "type":"string",
            "description":"Visit event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "maxLength":"16",
            "minLength":"1",
            "pattern":"[a-zA-Z0-9]+",
            "type":"string",
            "description":"Visit short name",
            "example":"Week1"
        },
        "visitDescription":{
            "type":"string",
            "description":"Visit description",
            "example":"Regular 2 week visit"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date time",
            "format":"date-time",
            "example":"2019-01-25T07:42:00.204Z"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "studyVersionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"TESTING"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch Id",
            "format":"uuid"
        }
    },
    "description":"Visit design."
}

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 v6.0
  Title: VisitDto v6.0

  Visit design.

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

Nested Schema : VisitDto v6.0

Type: object

Title: VisitDto v6.0

Visit design.

Show Source

• branchId: string (uuid)
  Branch Id
• endVisitId: string (uuid)
  End visit ID
• eventType: string
  Visit event type

  Example: ScreeningVisit
• id: string (uuid)
  Visit GUID
• lastRequired: boolean
  Yes - if Visit is last required.

  Example: false
• 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
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 16

  Pattern: [a-zA-Z0-9]+

  Visit short name

  Example: Week1
• startVisitId: string (uuid)
  Start visit ID
• studyVersion: string
  Study version

  Example: 1.0.0.1
• studyVersionStatus: string
  Study version status

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

  Maximum Length: 64

  Visit title

  Example: Week 2
• visitDescription: string
  Visit description

  Example: Regular 2 week visit
• visitStartDate: string (date-time)
  Visit start date time

  Example: 2019-01-25T07:42:00.204Z

{
    "title":"VisitDto v6.0",
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "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"
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit is last required.",
            "example":false
        },
        "eventType":{
            "type":"string",
            "description":"Visit event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "maxLength":"16",
            "minLength":"1",
            "pattern":"[a-zA-Z0-9]+",
            "type":"string",
            "description":"Visit short name",
            "example":"Week1"
        },
        "visitDescription":{
            "type":"string",
            "description":"Visit description",
            "example":"Regular 2 week visit"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date time",
            "format":"date-time",
            "example":"2019-01-25T07:42:00.204Z"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "studyVersionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"TESTING"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch Id",
            "format":"uuid"
        }
    },
    "description":"Visit design."
}

500 Response

Error

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