Jump to

• Request
• Response

V9.0

put

/ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}

Updates the visit status for given ID. It supports unscheduled visits.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  3F2504E04F8911D39A0C0305E82C3301

• visitStatusId(required): string(uuid)
  Visit ID to update.The format should be UUID, 32-character uppercase hexadecimal string

  Example:

  53915DD9B758466AB2226CBCC4466B7E

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Visit status including event instance number (v4) and visit window warning

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comment for the visit status

  Example: All data verified
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example: 1
• eventType: string
  Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.

  Example: Visit_Not_Started
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason associated with the visit status

  Example: Subject completed the visit successfully
• siteId: string
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100

  String representing the version of the study. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectId: string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• versionStart: string
  Start timestamp of the version record

  Example: 2025-10-16T14:30:31.892Z
• visitStartDate: string (date-time)
  Visit start date timestamp

  Example: 2025-10-16T14:30:31.892Z
• visitStatus: string
  Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

  Example: COMPLETE
• visitType: string
  Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.

  Example: SCREENING
• visitWindowWarning: string
  Warning for the visit scheduling window

  Example: NONE

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the version record",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the visit status",
            "example":"Subject completed the visit successfully"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment for the visit status",
            "example":"All data verified"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitType":{
            "type":"string",
            "description":"Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.",
            "example":"SCREENING"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.",
            "example":"Visit_Not_Started"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "visitWindowWarning":{
            "type":"string",
            "description":"Warning for the visit scheduling window",
            "example":"NONE"
        }
    },
    "description":"Visit status including event instance number (v4) and visit window warning"
}

Examples

Select an example VisitsStatusDto50

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : VisitsStatusRuleTargetsDto9

Type: object

Visit status update response including visit window warning, visit start date lock details, and rule targets

Show Source

• associatedStudyVersion: string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 3.0.0.1
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comment for the visit status

  Example: All data verified
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example: 1
• eventType: string
  Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.

  Example: Visit_Not_Started
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason associated with the visit status

  Example: Subject completed the visit successfully
• siteId: string
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100

  String representing the version of the study. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectId: string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• targets: array targets
  List of rule targets affected by this operation
• versionStart: string
  Start timestamp of the version record

  Example: 2025-10-16T14:30:31.892Z
• visitAction: string
  Action taken on the visit start date value. Acceptable values are SCREEN_ENABLE ,SCREEN_DISABLE ,RANDOMIZE_ENABLE ,RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE.

  Example: SCREEN_ENABLE
• visitStartDate: string (date-time)
  Visit start date timestamp

  Example: 2025-10-16T14:30:31.892Z
• visitStartDateLockedDateTime: string (date-time)
  Timestamp when the visit start date was locked

  Example: 2025-10-16T14:30:31.892Z
• visitStartDateLockedStatus: string
  Action performed on visit start date LOCKED, UNLOCKED, NEVER_LOCKED.
• visitStatus: string
  Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

  Example: COMPLETE
• visitType: string
  Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.

  Example: SCREENING
• visitWindowWarning: string
  Warning for the visit scheduling window

  Example: NONE

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the version record",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the visit status",
            "example":"Subject completed the visit successfully"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment for the visit status",
            "example":"All data verified"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitType":{
            "type":"string",
            "description":"Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.",
            "example":"SCREENING"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.",
            "example":"Visit_Not_Started"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "targets":{
            "type":"array",
            "description":"List of rule targets affected by this operation",
            "example":[
                "DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"
            ],
            "items":{
                "type":"string",
                "description":"List of rule targets affected by this operation",
                "example":"[\"DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC\"]"
            }
        },
        "associatedStudyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "visitAction":{
            "type":"string",
            "description":"Action taken on the visit start date value. Acceptable values are SCREEN_ENABLE ,SCREEN_DISABLE ,RANDOMIZE_ENABLE ,RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE.",
            "example":"SCREEN_ENABLE"
        },
        "visitStartDateLockedStatus":{
            "type":"string",
            "description":"Action performed on visit start date LOCKED, UNLOCKED, NEVER_LOCKED."
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "description":"Timestamp when the visit start date was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitWindowWarning":{
            "type":"string",
            "description":"Warning for the visit scheduling window",
            "example":"NONE"
        }
    },
    "description":"Visit status update response including visit window warning, visit start date lock details, and rule targets"
}

Nested Schema : targets

Type: array

List of rule targets affected by this operation

Show Source

• Array of: string
  List of rule targets affected by this operation

  Example: ["DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"]

{
    "type":"array",
    "description":"List of rule targets affected by this operation",
    "example":[
        "DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"
    ],
    "items":{
        "type":"string",
        "description":"List of rule targets affected by this operation",
        "example":"[\"DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC\"]"
    }
}

Example:

[
    "DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"
]

Examples

Select an example VisitsStatusRuleTargetsDto9

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested 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 : result

Type: object

Nested Schema : details

Type: object

Back to Top