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
  Title: ErrorResponseData

  Error Response Details Information
• 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

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."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top