Jump to

• Request
• Response

Get screened and randomized subjects for resupply

get

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

Retrieves the screened and randomized subjects for resupply grouped by site.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study to which the subject belongs.

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.
• ignoreSubjectsWhichSkippedVisit: boolean
  Boolean value to decide whether to return a subject that skipped a dispensation visit.

  Default Value: false
• siteId: string(uuid)
  Sites for which you want to retrieve subjects.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ResupplySubjectsListDto

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

Nested Schema : ResupplySubjectsListDto

Type: object

Show Source

• siteResupplySubjectsList: array siteResupplySubjectsList

{
    "type":"object",
    "properties":{
        "siteResupplySubjectsList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SiteResupplySubjectsListDto"
            }
        }
    }
}

Nested Schema : siteResupplySubjectsList

Type: array

Show Source

• Array of: object SiteResupplySubjectsListDto

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

Nested Schema : SiteResupplySubjectsListDto

Type: object

Show Source

• randomizedSubjects: array randomizedSubjects
• screenedSubjects: array screenedSubjects
• siteId: string

{
    "type":"object",
    "properties":{
        "siteId":{
            "type":"string"
        },
        "screenedSubjects":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "randomizedSubjects":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : randomizedSubjects

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : screenedSubjects

Type: array

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top