Jump to

• Request
• Response

V1.0

get

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/visits

Get visit level lock records for a visit

Request

Path Parameters

• eventId(required): string(uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example:

  D3AE48BD29FC4E379BC94AB8265A72CF

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  BA62DB18A9E347B899743D46853CEDCA

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  BA62DB18A9E347B899743D46853CEDCA

Query Parameters

• eventInstanceNum: integer(int64)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object VisitLockDetails
  DTO containing lock status details for a visit, including subject, event, lock statuses, and related timestamps.

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

Nested Schema : VisitLockDetails

Type: object

DTO containing lock status details for a visit, including subject, event, lock statuses, and related timestamps.

Show Source

• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: D3AE48BD29FC4E379BC94AB8265A72CF
• eventInstanceNum: integer (int64)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• lockStatus: string
  Lock status for this visit. applicable values are LOCKED, UNLOCKED

  Example: LOCKED
• lockStatusTime: string (date-time)
  Timestamp when current lock status became effective.

  Example: 2023-10-15T18:25:43Z
• subjectId: string (UUID)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: BA62DB18A9E347B899743D46853CEDCA
• visitStartDateLockStatus: string
  Lock status for the visit start date. applicable values are LOCKED, UNLOCKED

  Example: UNLOCKED
• visitStartDateLockStatusTime: string (date-time)
  Timestamp when visitStartDateLockStatus was set.

  Example: 2023-10-15T18:25:43Z

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"UUID",
            "example":"BA62DB18A9E347B899743D46853CEDCA"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"D3AE48BD29FC4E379BC94AB8265A72CF"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int64",
            "example":1
        },
        "lockStatus":{
            "type":"string",
            "description":"Lock status for this visit. applicable values are LOCKED, UNLOCKED",
            "example":"LOCKED"
        },
        "lockStatusTime":{
            "type":"string",
            "description":"Timestamp when current lock status became effective.",
            "format":"date-time",
            "example":"2023-10-15T18:25:43Z"
        },
        "visitStartDateLockStatus":{
            "type":"string",
            "description":"Lock status for the visit start date. applicable values are LOCKED, UNLOCKED",
            "example":"UNLOCKED"
        },
        "visitStartDateLockStatusTime":{
            "type":"string",
            "description":"Timestamp when visitStartDateLockStatus was set.",
            "format":"date-time",
            "example":"2023-10-15T18:25:43Z"
        }
    },
    "description":"DTO containing lock status details for a visit, including subject, event, lock statuses, and related timestamps."
}

Examples

Select an example Visit Lock Details

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top