Jump to

• Request
• Response

[Deprecated]: V1.0

get

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

Deprecated: Use latest version instead. Retrieves one kit definition from the specified study version. The kitId path parameter identifies the kit, and the response includes kit settings, unit settings, dosing details, titration settings, advanced dosing groups, and validation details when present.

Request

Path Parameters

• kitId(required): string
  Kit ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  7A4D3C2B1E8F4D56A23C9F3A0C7D4E22

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

There's no request body for this operation.

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 date

  Example: 2018-11-23T08:43:01.7Z

{
    "title":"KitDto v1.0",
    "type":"object",
    "properties":{
        "kitid":{
            "type":"string",
            "description":"Kit GUID",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Version Start date",
            "format":"date-time",
            "example":"2018-11-23T08:43:01.7Z"
        },
        "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."
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root 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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top