Jump to

• Request
• Response

v8.0

get

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

Returns all non-draft kit descriptions for the requested study mode, including Combination Kit Dosing metadata.

Request

Path Parameters

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

  Example:

  1.0.0.1

Query Parameters

• excludeKitType: boolean
  Default Value: false

  Allowed Values: [ true, false ]
• kitType: string
  Default Value: all

  Allowed Values: [ "standard", "device", "titration", "advancedDispensation", "all" ]
• mode(required): string
  Allowed Values: [ "test", "training", "active" ]
• unblinded: boolean
  Default Value: 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 RespKitDescDto

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

Nested Schema : RespKitDescDto

Type: object

Show Source

• advancedDispensation: boolean
  Is kit with advanced dispensation?

  Example: true
• combinationDosing: boolean
  Is kit with combination dosing?

  Example: true
• 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
• memberKitTypes: array memberKitTypes
  Member kit types for a combination kit.
• poolingId: string
  Pooling Kit ID

  Example: POL12
• serialized: boolean
  Is kit serialized?

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

  Example: BOTTLE

{
    "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"
        },
        "advancedDispensation":{
            "type":"boolean",
            "description":"Is kit with advanced dispensation?",
            "example":true
        },
        "combinationDosing":{
            "type":"boolean",
            "description":"Is kit with combination dosing?",
            "example":true
        },
        "memberKitTypes":{
            "type":"array",
            "description":"Member kit types for a combination kit.",
            "items":{
                "$ref":"#/components/schemas/KitDescMemberDtoV8"
            }
        },
        "serialized":{
            "type":"boolean",
            "description":"Is kit serialized?",
            "example":true
        }
    }
}

Nested Schema : memberKitTypes

Type: array

Member kit types for a combination kit.

Show Source

• Array of: object KitDescMemberDto V8.0
  Title: KitDescMemberDto V8.0

  Member kit type for a combination kit.

{
    "type":"array",
    "description":"Member kit types for a combination kit.",
    "items":{
        "$ref":"#/components/schemas/KitDescMemberDtoV8"
    }
}

Nested Schema : KitDescMemberDto V8.0

Type: object

Title: KitDescMemberDto V8.0

Member kit type for a combination kit.

Show Source

• kitId: string (uuid)
  Member Kit Unique GUID
• kitTypeId: string (uuid)
  Member Kit Type Unique GUID
• kitTypeName: string
  Member Kit Type Name

  Example: Sample Kit
• seq: integer (int32)
  Member kit sequence

  Example: 1

{
    "title":"KitDescMemberDto V8.0",
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Member Kit Unique GUID",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "description":"Member Kit Type Unique GUID",
            "format":"uuid"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Member Kit Type Name",
            "example":"Sample Kit"
        },
        "seq":{
            "type":"integer",
            "description":"Member kit sequence",
            "format":"int32",
            "example":1
        }
    },
    "description":"Member kit type for a combination kit."
}

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