Jump to

• Request
• Response

V7.0

post

/ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/repeatSection/consolidatedRepeatInstanceNumbers

Returns list of repeat form numbers, form section IDs and repeat instance numbers that belong to a given subject, visit and formIds.

Request

Path Parameters

• 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 to compute consolidated repeat instance numbers across multiple forms for a subject

Show Source

• forms: array forms
  List of form IDs for which consolidated repeat instance numbers are requested
• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: ABCDEF1234567890ABCDEF1234567890

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "forms":{
            "type":"array",
            "description":"List of form IDs for which consolidated repeat instance numbers are requested",
            "example":[
                "40DB4EF4847849CCB24EFCCB71CDA436",
                "50DB4EF4847849CCB24EFCCB71CDA436"
            ],
            "items":{
                "type":"string",
                "description":"List of form IDs for which consolidated repeat instance numbers are requested",
                "example":"[\"40DB4EF4847849CCB24EFCCB71CDA436\",\"50DB4EF4847849CCB24EFCCB71CDA436\"]"
            }
        }
    },
    "description":"Request to compute consolidated repeat instance numbers across multiple forms for a subject"
}

Nested Schema : forms

Type: array

List of form IDs for which consolidated repeat instance numbers are requested

Show Source

• Array of: string
  List of form IDs for which consolidated repeat instance numbers are requested

  Example: ["40DB4EF4847849CCB24EFCCB71CDA436","50DB4EF4847849CCB24EFCCB71CDA436"]

{
    "type":"array",
    "description":"List of form IDs for which consolidated repeat instance numbers are requested",
    "example":[
        "40DB4EF4847849CCB24EFCCB71CDA436",
        "50DB4EF4847849CCB24EFCCB71CDA436"
    ],
    "items":{
        "type":"string",
        "description":"List of form IDs for which consolidated repeat instance numbers are requested",
        "example":"[\"40DB4EF4847849CCB24EFCCB71CDA436\",\"50DB4EF4847849CCB24EFCCB71CDA436\"]"
    }
}

Example:

[
    "40DB4EF4847849CCB24EFCCB71CDA436",
    "50DB4EF4847849CCB24EFCCB71CDA436"
]

Examples

Select an example ConsolidatedRepeatInstanceRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ConsolidatedRepeatInstanceResponseDto
  Consolidated repeat instance numbers per form and event.

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

Nested Schema : ConsolidatedRepeatInstanceResponseDto

Type: object

Consolidated repeat instance numbers per form and event.

Show Source

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

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

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

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• instances: array instances
  Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "format":"UUID",
            "example":"CBCDEF1234567890ABCDEF1234567890"
        },
        "eventInstanceNumber":{
            "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":1
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "instances":{
            "type":"array",
            "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
            "example":[
                "1",
                "2"
            ],
            "items":{
                "type":"string",
                "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
                "example":"[\"1\",\"2\"]"
            }
        }
    },
    "description":"Consolidated repeat instance numbers per form and event."
}

Nested Schema : instances

Type: array

Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

Show Source

• Array of: string
  Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

  Example: ["1","2"]

{
    "type":"array",
    "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
    "example":[
        "1",
        "2"
    ],
    "items":{
        "type":"string",
        "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
        "example":"[\"1\",\"2\"]"
    }
}

Example:

[
    "1",
    "2"
]

Examples

Select an example ConsolidatedRepeatInstances

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