REST API for Clinical One Platform

Get kit types which do not belong to any blinding group

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kittypes/noblindinggroup

Retrieves kit types which do not belong to any blinding group. Rights: SupplySettingRightsGet. Required sponsor roles are: clinical supply manager and site manager.

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

Type: array

Show Source

Array of: object KitType

Kit types details object.

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

Nested Schema : KitType

Type: object

Kit types details object.

Show Source

countsPerPackage: number (double)

Counts per package.

Example: 5
description: string

Kit type description

Example: Non-Dosing
doNotDispense: number (double)

Value to indicate whether to dispense kits or not.

Example: 1
dosage: number (double)

Dosage.

Example: 1
id: string (uuid)

Kit type Id
isDefault: boolean

Indicate if kit is default.

Example: true
kitTypeId: string (uuid)

Kit type Id
kitTypeName: string

Kit type name

Example: Kit A
minShippingUnits: number (double)

Minimum Kits to Ship.

Example: 10
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: 10
srcId: string (uuid)

Id of the Study
srcVersionStart: string (date-time)

Study version start
storageNeedId: number (double)

Storage need ID.

Example: 1
studyId: string (uuid)

ID of the study
studyVersionStart: string (date-time)

Study version start
versionEnd: string (date-time)

Version End
versionStart: string (date-time)

Version Start

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kit type Id",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "countsPerPackage":{
            "type":"number",
            "description":"Counts per package.",
            "format":"double",
            "example":5
        },
        "description":{
            "type":"string",
            "description":"Kit type description",
            "example":"Non-Dosing"
        },
        "doNotDispense":{
            "type":"number",
            "description":"Value to indicate whether to dispense kits or not.",
            "format":"double",
            "example":1
        },
        "dosage":{
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":1
        },
        "minShippingUnits":{
            "type":"number",
            "description":"Minimum Kits to Ship.",
            "format":"double",
            "example":10
        },
        "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":10,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "studyId":{
            "type":"string",
            "description":"ID of the study",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Indicate if kit is default.",
            "example":true
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name",
            "example":"Kit A"
        },
        "storageNeedId":{
            "type":"number",
            "description":"Storage need ID.",
            "format":"double",
            "example":1
        },
        "srcId":{
            "type":"string",
            "description":"Id of the Study",
            "format":"uuid"
        },
        "srcVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "kitTypeId":{
            "type":"string",
            "description":"Kit type Id",
            "format":"uuid"
        }
    },
    "description":"Kit types details object."
}

404 Response

Study not found.

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.