Jump to

• Request
• Response

V5.0

get

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

Retrieves list of kits for all study versions in Testing, Approved and Archived states.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

Query Parameters

• kitType: string
  Kit type, such as standard, titration, device or all, to filter by. Optional.

  Default Value: all

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

  Example:

  all

• mode(required): string
  Study mode used to filter kits or titration. Allowed values: design (draft design data), test (testing data), training (training data), active (approved production data), all (all modes).

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

  Example:

  test

• unblinded: boolean
  Indicates whether unblinded fields are returned for users who have the OrsUnblinded permission. Optional.

  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 KitDescDto V5.0
  Title: KitDescDto V5.0

  Kit description and distribution setting

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

Nested Schema : KitDescDto V5.0

Type: object

Title: KitDescDto V5.0

Kit description and distribution setting

Show Source

• deviceConn: string
  Device Connection

  Example: D2C
• deviceType: string
  Device Type

  Example: SCALE
• distributionSetting: string (string)
  Distribution Setting

  Example: UNBLINDED
• kitDescription: string (string)
  Kit description

  Example: Kit_1003_1
• kitId: string (uuid)
  Kit Unique GUID
• kitType: string (string)
  Kit Type ID

  Example: Kit_1003_1
• libraryKitId: string (uuid)
  Library Kit GUID
• poolingId: string
  Pooling Kit ID

  Example: POL12
• titrationKit: string
  Indicates if this is a titration
• trialSupplyType: string
  Trial Supply Type

  Example: BOTTLE

{
    "title":"KitDescDto V5.0",
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Kit Unique GUID",
            "format":"uuid"
        },
        "kitType":{
            "type":"string",
            "description":"Kit Type ID",
            "format":"string",
            "example":"Kit_1003_1"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "format":"string",
            "example":"Kit_1003_1"
        },
        "distributionSetting":{
            "type":"string",
            "description":"Distribution Setting",
            "format":"string",
            "example":"UNBLINDED"
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"SCALE"
        },
        "deviceConn":{
            "type":"string",
            "description":"Device Connection",
            "example":"D2C"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "titrationKit":{
            "type":"string",
            "description":"Indicates if this is a titration"
        },
        "libraryKitId":{
            "type":"string",
            "description":"Library Kit GUID",
            "format":"uuid"
        },
        "poolingId":{
            "type":"string",
            "description":"Pooling Kit ID",
            "example":"POL12"
        }
    },
    "description":"Kit description and distribution setting"
}

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

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