Jump to

• Request
• Response

[Deprecated]: V5.0

get

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

Deprecated: Use latest version instead. Retrieves a visit in a 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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : VisitDto v5.0

Type: object

Title: VisitDto v5.0

Visit design returned with study version details.

Show Source

• endVisitId: string (uuid)
  End visit ID (UUID, 32-character uppercase hexadecimal string).
• eventType: string
  Visit event type

  Example: ScreeningVisit
• id: string (uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string).
• lastRequired: boolean
  Yes - if Visit is last required.

  Example: false
• randomization: string (uuid)
  Randomization ID (UUID, 32-character uppercase hexadecimal string).
• 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 (UUID, 32-character uppercase hexadecimal string).
• 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 v5.0",
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit ID (UUID, 32-character uppercase hexadecimal string).",
            "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 ID (UUID, 32-character uppercase hexadecimal string).",
            "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 (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        }
    },
    "description":"Visit design returned with study version details.",
    "example":{
        "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
        "title":"Screening",
        "repeatVisit":false,
        "repeatNumber":0,
        "requiredVisit":true,
        "randomization":"8E1A7B6C2D3F4A55B12C9D4E6F708192",
        "lastRequired":false,
        "eventType":"ScreeningVisit",
        "shortName":"SCR",
        "visitDescription":"Screening visit",
        "visitStartDate":"2024-01-15T10:30:00.000+00:00",
        "studyVersion":"1.0.0.1",
        "studyVersionStatus":"TESTING"
    }
}

Example:

{
    "id":"9F4A6C7E1B8F4D56A23C9F3A0C7D4E77",
    "title":"Screening",
    "repeatVisit":false,
    "repeatNumber":0,
    "requiredVisit":true,
    "randomization":"8E1A7B6C2D3F4A55B12C9D4E6F708192",
    "lastRequired":false,
    "eventType":"ScreeningVisit",
    "shortName":"SCR",
    "visitDescription":"Screening visit",
    "visitStartDate":"2024-01-15T10:30:00.000+00:00",
    "studyVersion":"1.0.0.1",
    "studyVersionStatus":"TESTING"
}

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