Jump to

• Request
• Response

[Deprecated]: Add a kit in a study

post

/ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits

Deprecated: Use latest version instead. Creates a new kit type in a study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID. Example: F054C951EB74443C93716CA714AB686E
• version(required): string
  Study version. Example: "1.0.0.1"

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• bufferdays: integer (int64)
• calculatingDoses: boolean
• dispenseOutsideWindow: boolean
• distributionSetting: string
• kitDescription: string
• kitEnd: string (date-time)
• kitId: string (uuid)
• kitRefName: string
• kitStart: string (date-time)
• kitTypeId: string
• libraryKitId: string (uuid)
• minShipUnits: integer (int64)
• objectVersionNumber: number
• operationType: string
• poolingId: string
• revision: string
• singleUnitDoseUnits: string
• singleUnitDoseValue: number (double)
• source: string
• storageSetting: string
• studyId: string (uuid)
• studyVersionEnd: string (date-time)
• studyVersionStart: string (date-time)
• titratingDoses: boolean
• titrationKit: integer (int64)
• trialSupplyType: string
• unitsPerKit: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string"
        },
        "kitRefName":{
            "type":"string"
        },
        "kitDescription":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "revision":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "storageSetting":{
            "type":"string"
        },
        "distributionSetting":{
            "type":"string"
        },
        "trialSupplyType":{
            "type":"string"
        },
        "unitsPerKit":{
            "type":"number"
        },
        "minShipUnits":{
            "type":"integer",
            "format":"int64"
        },
        "bufferdays":{
            "type":"integer",
            "format":"int64"
        },
        "dispenseOutsideWindow":{
            "type":"boolean"
        },
        "operationType":{
            "type":"string"
        },
        "kitStart":{
            "type":"string",
            "format":"date-time"
        },
        "kitEnd":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "calculatingDoses":{
            "type":"boolean"
        },
        "titratingDoses":{
            "type":"boolean"
        },
        "singleUnitDoseValue":{
            "type":"number",
            "format":"double"
        },
        "singleUnitDoseUnits":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "titrationKit":{
            "type":"integer",
            "format":"int64"
        },
        "libraryKitId":{
            "type":"string",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string"
        },
        "source":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : KitDto v1.0

Type: object

Title: KitDto v1.0

Kit details.

Show Source

• distributionSetting: string
  Kit distribution setting

  Example: BLINDED
• dosage: number (double)
  Dosage.

  Example: 50
• id: string (uuid)
• isDefault: boolean
  Is kit default.

  Example: true
• kitDescription: string
  Kit description

  Example: ORS-123(IP 0.01%)
• kitid: string (uuid)
  Kit GUID
• kitTypeId: string
  Kit type id/name

  Example: Type
• minShipUnits: integer (int64)
  Min units to ship.

  Example: 5
• storageSetting: string
  Kit storage setting

  Example: AMBIENT
• studyId: string (uuid)
  Study GUID
• studyVersionEnd: string (date-time)
  Study version end
• studyVersionStart: string (date-time)
  Study version start
• trialSupplyType: string
  Kit trial supply type

  Example: BOTTLE
• unitsPerKit: number (double)
  Units per kit.

  Example: 5
• versionEnd: string (date-time)
  Version End
• versionStart: string (date-time)
  Version Start

{
    "title":"KitDto v1.0",
    "type":"object",
    "properties":{
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version End",
            "format":"date-time"
        },
        "dosage":{
            "type":"number",
            "description":"Dosage.",
            "format":"double",
            "example":"50"
        },
        "studyId":{
            "type":"string",
            "description":"Study GUID",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "description":"Study version end",
            "format":"date-time"
        },
        "isDefault":{
            "type":"boolean",
            "description":"Is kit default.",
            "example":true
        },
        "kitTypeId":{
            "type":"string",
            "description":"Kit type id/name",
            "example":"Type"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "example":"ORS-123(IP 0.01%)"
        },
        "storageSetting":{
            "type":"string",
            "description":"Kit storage setting",
            "example":"AMBIENT"
        },
        "distributionSetting":{
            "type":"string",
            "description":"Kit distribution setting",
            "example":"BLINDED"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Kit trial supply type",
            "example":"BOTTLE"
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Units per kit.",
            "format":"double",
            "example":"5"
        },
        "minShipUnits":{
            "type":"integer",
            "description":"Min units to ship.",
            "format":"int64",
            "example":"5"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Kit details."
}

500 Response

Error

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

Back to Top