Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/forResupply

Retrieve the list of subjects per site eligible for resupply evaluation. Subjects are filtered based on visit windows, skip rules, and site selection.

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:

  ABCDEF1234567890ABCDEF1234567890

Query Parameters

• ignoreIfOutsideOfVisitWindowBy: integer(int32)
  Integer value for the number of days a subject can be outside its next dispensation visit window after which it will not be returned in the response.

  Example:

  2

• ignoreSubjectsWhichSkippedVisit: boolean
  Boolean value to decide whether to return a subject that skipped a dispensation visit.

  Default Value: false

  Example:

  false

• siteId: string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example:

  40DB4EF4847849CCB24EFCCB71CDA436

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

List of resupply-eligible subjects retrieved per site.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ResupplySubjectsListDto
  Aggregated subjects per site for resupply evaluation based on visit windows and skip rules

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

Nested Schema : ResupplySubjectsListDto

Type: object

Aggregated subjects per site for resupply evaluation based on visit windows and skip rules

Show Source

• siteResupplySubjectsList: array siteResupplySubjectsList
  Collection of per-site resupply subject lists

{
    "type":"object",
    "properties":{
        "siteResupplySubjectsList":{
            "type":"array",
            "description":"Collection of per-site resupply subject lists",
            "items":{
                "$ref":"#/components/schemas/SiteResupplySubjectsListDto"
            }
        }
    },
    "description":"Aggregated subjects per site for resupply evaluation based on visit windows and skip rules"
}

Nested Schema : siteResupplySubjectsList

Type: array

Collection of per-site resupply subject lists

Show Source

• Array of: object SiteResupplySubjectsListDto
  Subjects per site categorized by screening and randomization status for resupply processing

{
    "type":"array",
    "description":"Collection of per-site resupply subject lists",
    "items":{
        "$ref":"#/components/schemas/SiteResupplySubjectsListDto"
    }
}

Nested Schema : SiteResupplySubjectsListDto

Type: object

Subjects per site categorized by screening and randomization status for resupply processing

Show Source

• randomizedSubjects: array randomizedSubjects
  Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site
• screenedSubjects: array screenedSubjects
  Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "screenedSubjects":{
            "type":"array",
            "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site",
            "example":[
                "A3F1C4B2D8E947F0A1B2C3D4E5F6A7B8",
                "9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D"
            ],
            "items":{
                "type":"string",
                "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site",
                "format":"uuid"
            }
        },
        "randomizedSubjects":{
            "type":"array",
            "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site",
            "example":[
                "3C1D5E7F9A0B2C4D6E8F0A1B2C3D4E5F",
                "ABCDEF1234567890ABCDEF1234567890"
            ],
            "items":{
                "type":"string",
                "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site",
                "format":"uuid"
            }
        }
    },
    "description":"Subjects per site categorized by screening and randomization status for resupply processing"
}

Nested Schema : randomizedSubjects

Type: array

Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site

Show Source

• Array of: string(uuid)
  Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site

{
    "type":"array",
    "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site",
    "example":[
        "3C1D5E7F9A0B2C4D6E8F0A1B2C3D4E5F",
        "ABCDEF1234567890ABCDEF1234567890"
    ],
    "items":{
        "type":"string",
        "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are randomized at the site",
        "format":"uuid"
    }
}

Example:

[
    "3C1D5E7F9A0B2C4D6E8F0A1B2C3D4E5F",
    "ABCDEF1234567890ABCDEF1234567890"
]

Nested Schema : screenedSubjects

Type: array

Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site

Show Source

• Array of: string(uuid)
  Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site

{
    "type":"array",
    "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site",
    "example":[
        "A3F1C4B2D8E947F0A1B2C3D4E5F6A7B8",
        "9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D"
    ],
    "items":{
        "type":"string",
        "description":"Subject Identifiers (UUID, 32-character uppercase hexadecimal string) that are screened at the site",
        "format":"uuid"
    }
}

Example:

[
    "A3F1C4B2D8E947F0A1B2C3D4E5F6A7B8",
    "9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D"
]

Examples

Select an example Resupply Subjects List

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