Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kit-types

Retrieves kit types by study ID. Rights: OrsInventoryGet.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• */*

204 Response

Successful operation

Body ()

Root Schema : KitTypesResponse

Type: object

Title: KitTypesResponse

Response object containing kit types.

Show Source

• errorData: string
  Title: Error Data

  Error data.

  Example: Some string
• result: array Result
  Title: Result

  List of kit types.
• status: string
  Title: Status

  Status string.

  Example: success
• version: number (double)
  Title: Version

  Version.

  Example: 1

{
    "title":"KitTypesResponse",
    "type":"object",
    "properties":{
        "status":{
            "title":"Status",
            "type":"string",
            "description":"Status string.",
            "example":"success"
        },
        "result":{
            "title":"Result",
            "type":"array",
            "description":"List of kit types.",
            "items":{
                "$ref":"#/components/schemas/KitTypesTO"
            }
        },
        "errorData":{
            "title":"Error Data",
            "type":"string",
            "description":"Error data.",
            "example":"Some string"
        },
        "version":{
            "title":"Version",
            "type":"number",
            "description":"Version.",
            "format":"double",
            "example":1
        }
    },
    "description":"Response object containing kit types."
}

Nested Schema : Result

Type: array

Title: Result

List of kit types.

Show Source

• Array of: object KitTypesTO
  Contains details about kit types.

{
    "title":"Result",
    "type":"array",
    "description":"List of kit types.",
    "items":{
        "$ref":"#/components/schemas/KitTypesTO"
    }
}

Nested Schema : KitTypesTO

Type: object

Contains details about kit types.

Show Source

• bufferdays: number (BigDecimal)
  Buffer days.

  Example: 5
• dispenseOutsideWindow: string
  Allowed Values: [ "0", "1" ]

  Indicate whether to dispense kits outside window.

  Example: 1
• distributionSetting: string
  Allowed Values: [ "BLINDED", "UNBLINDED" ]

  Kit distribution setting.

  Example: BLINDED
• dosage: number (BigDecimal)
  Kit dosage.

  Example: 5
• id: string (uuid)
  Unique identifier
• isDefault: string
  Indicate if kit type is default.

  Example: 1
• kitDescription: string
  Kit description.

  Example: Some description
• kitId: string (uuid)
  Kit ID.
• kitTypeId: string
  Kit type ID.

  Example: kit_A
• minShipUnits: number (BigDecimal)
  Mininum kits to ship.

  Example: 5
• storageSetting: string
  Allowed Values: [ "AMBIENT", "REFRIGERATED", "FROZEN" ]

  Kit storage setting.

  Example: REFRIGERATED
• studyId: string (uuid)
  Study ID.
• studyVersionEnd: string (date-time)
  Study version end.
• studyVersionStart: string (date-time)
  Study version start.
• trialSupplyType: string
  Trial supply type for the kit.

  Example: BOTTLE
• unitsPerKit: number (BigDecimal)
  Number of units per kit.

  Example: 5
• versionEnd: string (date-time)
  Version end date.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "type":"object",
    "properties":{
        "kitId":{
            "type":"string",
            "description":"Kit ID.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        },
        "dosage":{
            "type":"number",
            "description":"Kit dosage.",
            "format":"BigDecimal",
            "example":5
        },
        "studyId":{
            "type":"string",
            "description":"Study ID.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time"
        },
        "studyVersionEnd":{
            "type":"string",
            "description":"Study version end.",
            "format":"date-time"
        },
        "isDefault":{
            "type":"string",
            "description":"Indicate if kit type is default.",
            "example":"1"
        },
        "kitTypeId":{
            "type":"string",
            "description":"Kit type ID.",
            "example":"kit_A"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description.",
            "example":"Some description"
        },
        "storageSetting":{
            "type":"string",
            "description":"Kit storage setting.",
            "example":"REFRIGERATED",
            "enum":[
                "AMBIENT",
                "REFRIGERATED",
                "FROZEN"
            ]
        },
        "distributionSetting":{
            "type":"string",
            "description":"Kit distribution setting.",
            "example":"BLINDED",
            "enum":[
                "BLINDED",
                "UNBLINDED"
            ]
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial supply type for the kit.",
            "example":"BOTTLE"
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Number of units per kit.",
            "format":"BigDecimal",
            "example":5
        },
        "minShipUnits":{
            "type":"number",
            "description":"Mininum kits to ship.",
            "format":"BigDecimal",
            "example":5
        },
        "bufferdays":{
            "type":"number",
            "description":"Buffer days.",
            "format":"BigDecimal",
            "example":5
        },
        "dispenseOutsideWindow":{
            "type":"string",
            "description":"Indicate whether to dispense kits outside window.",
            "example":"1",
            "enum":[
                "0",
                "1"
            ]
        },
        "id":{
            "type":"string",
            "description":"Unique identifier",
            "format":"uuid"
        }
    },
    "description":"Contains details about kit types."
}

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top