REST API for Clinical One Platform

Get all blinding groups

get

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

Retrieves all blinding groups in a study. Rights: SupplySettingRightsPost. Required sponsor roles are: clinical supply manager and site manager.Please refer to getPackageTypes API for packageTypeId. A study cannot have both DEFAULT and RANDOM blinding group strategies. Based upon the single kit setting (RANDOM, DEFAULT, ALL) at a study level, the UI should restrict drop down values (SEND_KIT_TYPE/RANDOM_KIT). RANDOM_KIT should be hidden if the single kit setting at a study level is DEFAULT. Similarly, SEND_KIT_TYPE should be hidden if the single kit setting is RANDOMor ALL. getStudy API has been modified to return more parameters like singleKitSettingId and useBlindingGroups

Request

Path Parameters

mode(required): string

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

ID of the study

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : BlindingGroupResponse

Type: object

Show Source

blindingGroups: array blindingGroups

{
    "type":"object",
    "properties":{
        "blindingGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BlindingGroupResponse.BlindingGroupV2"
            }
        }
    }
}

Nested Schema : blindingGroups

Type: array

Show Source

Array of: object BlindingGroupResponse.BlindingGroup v2.0

Title: BlindingGroupResponse.BlindingGroup v2.0

Object containing blinding group details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BlindingGroupResponse.BlindingGroupV2"
    }
}

Nested Schema : BlindingGroupResponse.BlindingGroup v2.0

Type: object

Title: BlindingGroupResponse.BlindingGroup v2.0

Object containing blinding group details.

Show Source

defaultBlindingKit: string

ID of the default kit in the blinding group.

Example: 392DA9F053E94B9B9339AC7D0FA0D1DB
description: string

Description of the blinding group

Example: Some description.
id: string (uuid)

Blinding group ID
kitTypes: array kitTypes
title: string

Title of the blinding group

Example: Blinding Group Lotion

{
    "title":"BlindingGroupResponse.BlindingGroup v2.0",
    "type":"object",
    "properties":{
        "title":{
            "type":"string",
            "description":"Title of the blinding group",
            "example":"Blinding Group Lotion"
        },
        "description":{
            "type":"string",
            "description":"Description of the blinding group",
            "example":"Some description."
        },
        "defaultBlindingKit":{
            "type":"string",
            "description":"ID of the default kit in the blinding group.",
            "example":"392DA9F053E94B9B9339AC7D0FA0D1DB"
        },
        "id":{
            "type":"string",
            "description":"Blinding group ID",
            "format":"uuid"
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BlindingGroupResponse.KitTypeSummaryV2"
            }
        }
    },
    "description":"Object containing blinding group details."
}

Nested Schema : kitTypes

Type: array

Show Source

Array of: object BlindingGroupResponse.KitTypeSummary v2.0

Title: BlindingGroupResponse.KitTypeSummary v2.0

Object for kit type summary details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BlindingGroupResponse.KitTypeSummaryV2"
    }
}

Nested Schema : BlindingGroupResponse.KitTypeSummary v2.0

Type: object

Title: BlindingGroupResponse.KitTypeSummary v2.0

Object for kit type summary details.

Show Source

description: string

Kit type description.

Example: Non dosing kit
deviceConnection: string

Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

Device Connection Type

Example: NoConnection
deviceType: string

Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

Device Type

Example: GlucoseMonitor
id: string

ID of the kit type.

Example: kitA
kitTypeName: string

Kit type name.

Example: Kit A
packageType: string

Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

Package Type

Example: BOTTLE
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
srcId: string

ID of the kit type.

Example: D313327EF13845169A8ADADDA435431E

{
    "title":"BlindingGroupResponse.KitTypeSummary v2.0",
    "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"
            ]
        },
        "packageType":{
            "type":"string",
            "description":"Package Type",
            "example":"BOTTLE",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"GlucoseMonitor",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Device Connection Type",
            "example":"NoConnection",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "srcId":{
            "type":"string",
            "description":"ID of the kit type.",
            "example":"D313327EF13845169A8ADADDA435431E"
        }
    },
    "description":"Object for kit type summary details."
}

404 Response

Invalid study.

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

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

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

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

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

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

Result Object

Nested Schema : details

Type: object