REST API for Clinical One Cloud Service

v1.0

get

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

Retrieves blinding group in a study by blinding group ID.
Required sponsor roles are: clinical supply manager and site manager.
Rights: SupplySettingRightsPost.

Request

Path Parameters

blindingGroupId(required): string(uuid)
ID of blinding group.
Example:
```
B1B8327AFAA6412287106192AB5984EF
```
mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
studyId(required): string(uuid)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
B1B8327AFAA6412287106192AB5984EF
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : BlindingGroup

Type: object

Title: BlindingGroup

Object containing blinding group details.

Show Source

defaultBlindingKit: string

Title: Default Blinding Kit

ID of the default kit in the blinding group.

Example: 392DA9F053E94B9B9339AC7D0FA0D1DB
description: string

Title: Description

Blinding group description.

Example: Some description.
id: string (uuid)

Title: Blinding Group ID

ID of blinding group.
kitTypes: array Kit Types

Title: Kit Types

List of kit types in the blinding group.
title: string

Title: Title

Blinding group title.

Example: Blinding Group Lotion

{
    "title":"BlindingGroup",
    "type":"object",
    "properties":{
        "title":{
            "title":"Title",
            "type":"string",
            "description":"Blinding group title.",
            "example":"Blinding Group Lotion"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Blinding group description.",
            "example":"Some description."
        },
        "defaultBlindingKit":{
            "title":"Default Blinding Kit",
            "type":"string",
            "description":"ID of the default kit in the blinding group.",
            "example":"392DA9F053E94B9B9339AC7D0FA0D1DB"
        },
        "id":{
            "title":"Blinding Group ID",
            "type":"string",
            "description":"ID of blinding group.",
            "format":"uuid"
        },
        "kitTypes":{
            "title":"Kit Types",
            "type":"array",
            "description":"List of kit types in the blinding group.",
            "example":[
                {
                    "id":"kitA",
                    "kitTypeName":"Kit A",
                    "description":"Non dosing kit",
                    "packageTypeId":5
                }
            ],
            "items":{
                "$ref":"#/components/schemas/BlindingGroupResponse.KitTypeSummary"
            }
        }
    },
    "description":"Object containing blinding group details.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "title":"Blinding Group Lotion",
        "description":"Some description.",
        "kitTypes":[
            {
                "id":"kitA",
                "kitTypeName":"Kit A",
                "description":"Non dosing kit",
                "packageTypeId":5
            }
        ],
        "defaultBlindingKit":"392DA9F053E94B9B9339AC7D0FA0D1DB"
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "title":"Blinding Group Lotion",
    "description":"Some description.",
    "kitTypes":[
        {
            "id":"kitA",
            "kitTypeName":"Kit A",
            "description":"Non dosing kit",
            "packageTypeId":5
        }
    ],
    "defaultBlindingKit":"392DA9F053E94B9B9339AC7D0FA0D1DB"
}

Nested Schema : Kit Types

Type: array

Title: Kit Types

List of kit types in the blinding group.

Show Source

Array of: object KitTypeSummary

Title: KitTypeSummary

Object for kit type summary details.

{
    "title":"Kit Types",
    "type":"array",
    "description":"List of kit types in the blinding group.",
    "example":[
        {
            "id":"kitA",
            "kitTypeName":"Kit A",
            "description":"Non dosing kit",
            "packageTypeId":5
        }
    ],
    "items":{
        "$ref":"#/components/schemas/BlindingGroupResponse.KitTypeSummary"
    }
}

Example:

[
    {
        "id":"kitA",
        "kitTypeName":"Kit A",
        "description":"Non dosing kit",
        "packageTypeId":5
    }
]

Nested Schema : KitTypeSummary

Type: object

Title: KitTypeSummary

Object for kit type summary details.

Show Source

description: string

Title: Description

Kit type description.

Example: Non dosing kit
deviceConnection: string

Title: mHealth Device Connection Type

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

Connection type of the mHealth device.

Example: NoConnection
deviceType: string

Title: mHealth Device Type

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

Type of the mHealth device.

Example: GlucoseMonitor
id: string

Title: Kit Type ID

ID of the kit type.

Example: kitA
kitTypeName: string

Title: Kit Type Name

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)

Title: Package Type ID

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

Title: KitType Source ID

Kit type source ID.

Example: D313327EF13845169A8ADADDA435431E

{
    "title":"KitTypeSummary",
    "type":"object",
    "properties":{
        "id":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"ID of the kit type.",
            "example":"kitA"
        },
        "kitTypeName":{
            "title":"Kit Type Name",
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "title":"Package Type ID",
            "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":{
            "title":"mHealth Device Type",
            "type":"string",
            "description":"Type of the mHealth device.",
            "example":"GlucoseMonitor",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "title":"mHealth Device Connection Type",
            "type":"string",
            "description":"Connection type of the mHealth device.",
            "example":"NoConnection",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "srcId":{
            "title":"KitType Source ID",
            "type":"string",
            "description":"Kit type source ID.",
            "example":"D313327EF13845169A8ADADDA435431E"
        }
    },
    "description":"Object for kit type summary details.",
    "example":{
        "id":"BOTTLE-A",
        "kitTypeName":"Kit A",
        "description":"Non dosing kit",
        "packageTypeId":5
    }
}

Example:

{
    "id":"BOTTLE-A",
    "kitTypeName":"Kit A",
    "description":"Non dosing kit",
    "packageTypeId":5
}

Examples

404 Response

Invalid study. OR Blinding Group not found.

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

Examples

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

Examples