Jump to

• Request
• Response

V4.0

post

/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/verify

Verifies multiple data elements for a subject based on the data element ID..

Request

Path Parameters

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

  Example:

  active

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

  Example:

  ABCDEF1234567890ABCDEF1234567890

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request for bulk unsign or unverify operations for a specific event/subject.

Show Source

• comment: string
  Any extra comment for the unsign/unverify action.

  Example: The data required is missing.
• elements: array elements
  List of core sign/verify target elements.
• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

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

  Example: 3
• reason: string
  Reason for the operation, if supplied.

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

  Maximum Length: 100

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

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

  Example: AF77C6450BE94DE293C9630142E0AFAD

{
    "required":[
        "studyVersion"
    ],
    "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":"AF77C6450BE94DE293C9630142E0AFAD"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"2.0.0.38"
        },
        "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":"int32",
            "example":3
        },
        "reason":{
            "type":"string",
            "description":"Reason for the operation, if supplied.",
            "example":"Other"
        },
        "comment":{
            "type":"string",
            "description":"Any extra comment for the unsign/unverify action.",
            "example":"The data required is missing."
        },
        "elements":{
            "type":"array",
            "description":"List of core sign/verify target elements.",
            "items":{
                "$ref":"#/components/schemas/CoreSignVerifyRequestDto"
            }
        }
    },
    "description":"Request for bulk unsign or unverify operations for a specific event/subject.",
    "xml":{
        "name":"signVerifyRequest"
    }
}

Nested Schema : elements

Type: array

List of core sign/verify target elements.

Show Source

• Array of: object CoreSignVerifyRequestDto
  DTO for a single data element to be signed/unverified as part of a bulk request.

{
    "type":"array",
    "description":"List of core sign/verify target elements.",
    "items":{
        "$ref":"#/components/schemas/CoreSignVerifyRequestDto"
    }
}

Nested Schema : CoreSignVerifyRequestDto

Type: object

DTO for a single data element to be signed/unverified as part of a bulk request.

Show Source

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

  Example: 3
• formId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 7978B7DD0A0A4CA899C485990994300C
• formSectionId: string (UUID)
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
• innerRepeat: integer (int64)
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example: 1
• itemId: string (UUID)
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: 7978B7DD0A0A4CA899C485990994300C
• outerRepeat: integer (int64)
  Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.

  Example: 1
• repeatFormNumber: integer (int64)
  Form repeat number if applicable.

  Example: 0
• repeatSequenceNumber: integer (int64)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        },
        "formSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "format":"UUID",
            "example":"33CAF3CB1DF64DF5A353A337CBE6B50A"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int64",
            "example":1
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Form repeat number if applicable.",
            "format":"int64",
            "example":0
        },
        "innerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.",
            "format":"int64",
            "example":1
        },
        "outerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.",
            "format":"int64",
            "example":1
        },
        "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":"int32",
            "example":3
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"UUID",
            "example":"7978B7DD0A0A4CA899C485990994300C"
        }
    },
    "description":"DTO for a single data element to be signed/unverified as part of a bulk request."
}

Examples

Select an example VerifyRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

400 Response

Bad request.

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