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
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  CDBBCCDDEEFF11223344556677889900

• subjectId(required): string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  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
  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