REST API for Clinical One Platform

Get all resupply groups

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies

Retrieves all resupply groups created for a study. Rights: SupplySettingRightsGet. Required sponsor roles are clinical supply manager and site manager.triggerWeeks and resupplyWeeks fields aren't needed for Min/Max strategies, so they're hidden when fetched.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

Query Parameters

resupplyTypeId(required): integer(int32)

ID of resupply type

Allowed Values: [ null ]
type: string

type of resupply type

Allowed Values: [ "Site,Depot" ]

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ResupplyGroupResponseV2

Type: object

Response object for resupply group.

Show Source

resupplies: array resupplies

{
    "type":"object",
    "properties":{
        "resupplies":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resupplies"
            }
        }
    },
    "description":"Response object for resupply group."
}

Nested Schema : resupplies

Type: array

Show Source

Array of: object resupplies

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

Nested Schema : resupplies

Type: object

Show Source

id: string (uuid)

Resupply Id
kitTypes: array kitTypes
resupplyName: string

Resupply name

Example: Resupply 1
resupplyTypeId: number (Integer)

Id of the resupply type.

Example: 2
type: string

type.

Example: Site

{
    "type":"object",
    "properties":{
        "resupplyName":{
            "type":"string",
            "description":"Resupply name",
            "example":"Resupply 1"
        },
        "resupplyTypeId":{
            "type":"number",
            "description":"Id of the resupply type.",
            "format":"Integer",
            "example":2
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResupplyGroupResponse.KitTypeSummary"
            }
        },
        "type":{
            "type":"string",
            "description":"type.",
            "example":"Site"
        },
        "id":{
            "type":"string",
            "description":"Resupply Id",
            "format":"uuid"
        }
    }
}

Nested Schema : kitTypes

Type: array

Show Source

Array of: object ResupplyGroupResponse.KitTypeSummary

Kit type summary details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResupplyGroupResponse.KitTypeSummary"
    }
}

Nested Schema : ResupplyGroupResponse.KitTypeSummary

Type: object

Kit type summary details object.

Show Source

description: string

Kit type description.

Example: Non dosing kit
id: string

ID of the kit type.

Example: kitA
initialShippingUnits: number (double)

The number of kits of each type that are in the initial shipment.

Example: 50
kitTypeName: string

Kit type name.

Example: Kit A
manualConsignment: number (double)

The number of kits of each type that are included in a manual shipment.

Example: 50
maxBuffer: number (double)

The number of kits that will be present at the site after a resupply shipment arrives.

Example: 50
minBuffer: number (double)

The number of kits that trigger a shipment when the resupply strategy runs.

Example: 5
packageTypeId: number (double)

Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

Example: 5
resupplyWeeks: number (double)

The number of weeks that the resupply strategy resupplies for.

Example: 3
triggerWeeks: number (double)

The number of weeks that the resupply strategy looks out to determine the supply.

Example: 3

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "example":"kitA"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "minBuffer":{
            "type":"number",
            "description":"The number of kits that trigger a shipment when the resupply strategy runs.",
            "format":"double",
            "example":5
        },
        "maxBuffer":{
            "type":"number",
            "description":"The number of kits that will be present at the site after a resupply shipment arrives.",
            "format":"double",
            "example":50
        },
        "initialShippingUnits":{
            "type":"number",
            "description":"The number of kits of each type that are in the initial shipment.",
            "format":"double",
            "example":50
        },
        "manualConsignment":{
            "type":"number",
            "description":"The number of kits of each type that are included in a manual shipment.",
            "format":"double",
            "example":50
        },
        "triggerWeeks":{
            "type":"number",
            "description":"The number of weeks that the resupply strategy looks out to determine the supply.",
            "format":"double",
            "example":3
        },
        "resupplyWeeks":{
            "type":"number",
            "description":"The number of weeks that the resupply strategy resupplies for.",
            "format":"double",
            "example":3
        }
    },
    "description":"Kit type summary details object."
}

404 Response

Resupply not found.

Root Schema : ORSResponse

Type: object

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

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

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
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":"string",
            "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

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

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

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

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
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":"string",
            "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

Result Object