Jump to

• Request
• Response

[Deprecated]: V6.0

get

/ec-designer-ors-svc/rest/v6.0/studies/{studyId}/kits

Deprecated: Use latest version instead. Retrieves list of kits for all study versions in Testing, Approved and Archived states.

Request

Path Parameters

• studyId(required): string(uuid)
  Study unique identifier.

Query Parameters

• kitType: string
  Minimum Length: 3

  Maximum Length: 9

  Optional. Kit category filter. Allowed values: standard = standard kits, device = device kits, titration = titration kits, all = all kit categories. Defaults to all when omitted.

  Default Value: all

  Allowed Values: [ "standard", "device", "titration", "all" ]

  Example:

  all

• mode(required): string
  Minimum Length: 4

  Maximum Length: 8

  Required. Study version mode filter. Allowed values: test = testing study versions, training = training study versions, active = active study versions.

  Allowed Values: [ "test", "training", "active" ]

  Example:

  active

• unblinded: boolean
  Optional. Indicates whether unblinded kit fields should be included in the response. Defaults to false when omitted.

  Default Value: false

  Example:

  false

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object KitsAllItemV6
  Kit summary returned by the v6 get-all-kits endpoint.

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

Nested Schema : KitsAllItemV6

Type: object

Kit summary returned by the v6 get-all-kits endpoint.

Show Source

• deviceConn: string
  Minimum Length: 1

  Maximum Length: 32

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

  Device connectivity type. Allowed values: CloudtoCloud = sync through an external cloud, DevicetoCloud = device sends data directly to the platform cloud, NoConnection = no connectivity is required.

  Example: DevicetoCloud
• deviceType: string
  Minimum Length: 1

  Maximum Length: 64

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

  Device type for device kits. Allowed values: ActivityWatch, BloodPressureMonitor, WeightScale, ECGReader, Spirometer, MobileApp, SmartPillBottle, PulseOximeter, WearablePatch, Other, GlucoseMonitor.

  Example: WeightScale
• distributionSetting: string
  Minimum Length: 1

  Maximum Length: 32

  Allowed Values: [ "BLINDED", "UNBLINDED", "UNBLINDEDPHARMAC" ]

  Distribution setting for the kit. Allowed values: BLINDED = treatment assignment remains hidden, UNBLINDED = treatment assignment is visible, UNBLINDEDPHARMAC = treatment assignment is visible for pharmacy-managed workflows.

  Example: UNBLINDED
• kitDescription: string
  Minimum Length: 1

  Maximum Length: 255

  Kit description displayed to study designers.

  Example: Standard treatment kit
• kitId: string (uuid)
  Minimum Length: 32

  Maximum Length: 32

  Kit unique identifier.
• kitTypeId: string
  Minimum Length: 1

  Maximum Length: 64

  Kit type identifier.

  Example: KIT_STD_001
• libraryKitId: string (uuid)
  Minimum Length: 32

  Maximum Length: 32

  Library kit unique identifier when the kit is based on a library kit.
• poolingId: string
  Minimum Length: 1

  Maximum Length: 64

  Pooling identifier for pooled kit configurations.

  Example: POOL12
• serialized: boolean
  Indicates whether the kit is serialized.

  Example: true
• titrationKit: boolean
  Indicates whether the kit is configured as a titration kit.

  Example: false
• trialSupplyType: string
  Minimum Length: 1

  Maximum Length: 32

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

  Trial supply type for the kit. Allowed values: BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX, OTHER.

  Example: BOTTLE

{
    "type":"object",
    "properties":{
        "kitId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Kit unique identifier.",
            "format":"uuid"
        },
        "kitTypeId":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Kit type identifier.",
            "example":"KIT_STD_001"
        },
        "kitDescription":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Kit description displayed to study designers.",
            "example":"Standard treatment kit"
        },
        "distributionSetting":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Distribution setting for the kit. Allowed values: BLINDED = treatment assignment remains hidden, UNBLINDED = treatment assignment is visible, UNBLINDEDPHARMAC = treatment assignment is visible for pharmacy-managed workflows.",
            "example":"UNBLINDED",
            "enum":[
                "BLINDED",
                "UNBLINDED",
                "UNBLINDEDPHARMAC"
            ]
        },
        "deviceType":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Device type for device kits. Allowed values: ActivityWatch, BloodPressureMonitor, WeightScale, ECGReader, Spirometer, MobileApp, SmartPillBottle, PulseOximeter, WearablePatch, Other, GlucoseMonitor.",
            "example":"WeightScale",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConn":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Device connectivity type. Allowed values: CloudtoCloud = sync through an external cloud, DevicetoCloud = device sends data directly to the platform cloud, NoConnection = no connectivity is required.",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "trialSupplyType":{
            "maxLength":32,
            "minLength":1,
            "type":"string",
            "description":"Trial supply type for the kit. Allowed values: BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX, OTHER.",
            "example":"BOTTLE",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "titrationKit":{
            "type":"boolean",
            "description":"Indicates whether the kit is configured as a titration kit.",
            "example":false
        },
        "libraryKitId":{
            "maxLength":32,
            "minLength":32,
            "type":"string",
            "description":"Library kit unique identifier when the kit is based on a library kit.",
            "format":"uuid"
        },
        "poolingId":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Pooling identifier for pooled kit configurations.",
            "example":"POOL12"
        },
        "serialized":{
            "type":"boolean",
            "description":"Indicates whether the kit is serialized.",
            "example":true
        }
    },
    "description":"Kit summary returned by the v6 get-all-kits endpoint."
}

Examples

Select an example GetKitsAllSuccess

500 Response

Returned when the service cannot retrieve kits for the supplied study and mode, or cannot apply the requested kitType and unblinded filters because of an unexpected server-side failure.

Body ()

Root 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 : details

Type: object

Examples

Select an example GetKitsAllError

Back to Top