Jump to

• Request
• Response

v11.0

post

/ec-designer-study-svc/rest/v11.0/studies/{studyId}/versions/{version}/visits

Creates a visit in v11.0 for the requested study version. Compared with v10.0, this version accepts nextVisitWithoutCompletion.

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

• copyScreeningVisit: boolean
  Copy the screening event to make an identical re-screen event. Optional.

  Default Value: false

  Example:

  false

• toTop: boolean
  Add visit to top in branch schedule. Optional.

  Default Value: false

  Example:

  false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• branchId: string (uuid)
  Branch Id
• branchTitle: string
  Visit Branch title

  Example: Branch 2
• endVisitId: string (uuid)
  End visit ID
• eventType: string
  Visit event type

  Example: ScreeningVisit
• fullName: string
  Concatenation of Visit Title and Branch title with hypen

  Example: B1C01 - V01
• 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
• timeLine: integer (int32)
  show in timeline. allows the designer to set when a visit can be shown to a user.

  Example: 1
• 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

{
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "branchTitle":{
            "type":"string",
            "description":"Visit Branch title",
            "example":"Branch 2"
        },
        "fullName":{
            "type":"string",
            "description":"Concatenation of Visit Title and Branch title with hypen",
            "example":"B1C01 - V01"
        },
        "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"
        },
        "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
        }
    }
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : RespVisitDto

Type: object

Show Source

• branchId: string (uuid)
  Branch ID.
• branchTitle: string
  Visit branch title.

  Example: Branch 2
• endVisitId: string (uuid)
  End visit ID.
• eventType: string
  Visit event type.

  Example: ScreeningVisit
• fullName: string
  Concatenation of visit title and branch title with hyphen.

  Example: B1C01 - V01
• id: string (uuid)
  Visit GUID.
• lastRequired: boolean
  Indicates whether the visit is the last required visit.

  Example: false
• nextVisitWithoutCompletion: boolean
  Indicates whether the next eligible visit can be started before this visit is complete. True and false apply to eligible Scheduled, Rescreening, and Screen Failure visits; the value is omitted when not applicable.

  Example: false
• randomization: string (uuid)
  Randomization GUID.
• repeatNumber(required): integer (int32)
  Number of times to repeat the visit design.

  Example: 5
• repeatVisit(required): boolean
  Indicates whether the visit design is repeating.

  Example: false
• requiredVisit(required): boolean
  Indicates whether the visit design is required.

  Example: false
• sdvRequired: string
  Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]

  Source Data Verification type.

  Example: NOTSET(0),NEVER(1),ALWAYS(2),CRITICAL(3)
• 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
• timeLine: integer (int32)
  Shows the visit in the timeline and lets the designer set when it can be shown to a user.

  Example: 1
• 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

{
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "branchTitle":{
            "type":"string",
            "description":"Visit branch title.",
            "example":"Branch 2"
        },
        "fullName":{
            "type":"string",
            "description":"Concatenation of visit title and branch title with hyphen.",
            "example":"B1C01 - V01"
        },
        "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":"Indicates whether the visit design is repeating.",
            "example":false
        },
        "repeatNumber":{
            "type":"integer",
            "description":"Number of times to repeat the visit design.",
            "format":"int32",
            "example":5
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Indicates whether the visit design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization GUID.",
            "format":"uuid"
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Indicates whether the visit is the last required visit.",
            "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"
        },
        "timeLine":{
            "type":"integer",
            "description":"Shows the visit in the timeline and lets the designer set when it can be shown to a user.",
            "format":"int32",
            "example":1
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification type.",
            "example":"NOTSET(0),NEVER(1),ALWAYS(2),CRITICAL(3)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "nextVisitWithoutCompletion":{
            "type":"boolean",
            "description":"Indicates whether the next eligible visit can be started before this visit is complete. True and false apply to eligible Scheduled, Rescreening, and Screen Failure visits; the value is omitted when not applicable.",
            "example":false
        }
    }
}

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