Get all blinding groups
get
/ec-ors-svc/rest/v1.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.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : blindingGroups
Type:
Show Source
array
-
Array of:
object BlindingGroupResponse.BlindingGroup v2.0
Title:
BlindingGroupResponse.BlindingGroup v2.0
Object containing blinding group details.
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 groupExample:
Some description.
-
id: string
(uuid)
Blinding group ID
-
kitTypes: array
kitTypes
-
title: string
Title of the blinding groupExample:
Blinding Group Lotion
Nested Schema : kitTypes
Type:
Show Source
array
-
Array of:
object BlindingGroupResponse.KitTypeSummary v2.0
Title:
BlindingGroupResponse.KitTypeSummary v2.0
Object for kit type summary details.
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 TypeExample:NoConnection
-
deviceType: string
Allowed Values:
[ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]
Device TypeExample: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 TypeExample: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
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 requestExample:
Success
-
version: integer
(int32)
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 requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object