Jump to

• Request
• Response

[Deprecated]: V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history

Deprecated: Retrieves the latest audit records for visit verification.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request to fetch visit verify history for specified subjects within a date range. Dates must be provided in dd-MMM-yyyy format (Example- 01-Jan-2023).

Show Source

• endDate: string (date-time)
  End date in dd-MMM-yyyy format
• startDate: string (date-time)
  Start date in dd-MMM-yyyy format
• subjects: array subjects
  List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
            "example":[
                "5D5F9311C591424F852B99FD902E98A4",
                "6D5F9311C591424F852B99FD902E98A4"
            ],
            "items":{
                "type":"string",
                "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
                "format":"uuid"
            }
        },
        "startDate":{
            "type":"string",
            "description":"Start date in dd-MMM-yyyy format",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"End date in dd-MMM-yyyy format",
            "format":"date-time"
        }
    },
    "description":"Request to fetch visit verify history for specified subjects within a date range. Dates must be provided in dd-MMM-yyyy format (Example- 01-Jan-2023)."
}

Nested Schema : subjects

Type: array

List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by

Show Source

• Array of: string(uuid)
  List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by

{
    "type":"array",
    "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
    "example":[
        "5D5F9311C591424F852B99FD902E98A4",
        "6D5F9311C591424F852B99FD902E98A4"
    ],
    "items":{
        "type":"string",
        "description":"List of subject unique identifiers in UUID, 32-character uppercase hexadecimal string format to filter by",
        "format":"uuid"
    }
}

Example:

[
    "5D5F9311C591424F852B99FD902E98A4",
    "6D5F9311C591424F852B99FD902E98A4"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : DcsResponse

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