Jump to

• Request
• Response

V2.0

get

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dispensedvisits/{subjectId}

Returns all dispensed visits associated with the given subject in the study. Use subjectId as path parameter (UUID, uppercase hex). Response contains an array of DispensedVisit objects, each with visitId and visitName.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  CDBBCCDDEEFF11223344556677889900

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

  Example:

  ABCDEF1234567890ABCDEF1234567890

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of dispensed visits by subject.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DispensedVisit
  Represents a dispensed visit instance linked to a subject in a clinical study

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

Nested Schema : DispensedVisit

Type: object

Represents a dispensed visit instance linked to a subject in a clinical study

Show Source

• visitId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  Example: ABCDEF1234567890ABCDEF1234567890
• VisitName: string
  Name of the dispensed visit

  Example: Baseline

{
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "VisitName":{
            "type":"string",
            "description":"Name of the dispensed visit",
            "example":"Baseline"
        }
    },
    "description":"Represents a dispensed visit instance linked to a subject in a clinical study"
}

Examples

Select an example SuccessfulResponse

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