REST API for Clinical One Platform

~~[Deprecated]: Get kit summary~~

get

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

Deprecated: Retrieves a kit's summary. Rights: OrsInventoryGet and OrsUnblinded.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

Query Parameters

kitRange(required): string

Range of the kit
kitStatus(required): string

Status of the kit
kitTypeId(required): string

ID of the kit type.
labelGroupId(required): string

ID of the label group
location(required): string

Location of the kit
lotId(required): string

ID of the lot

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object KitTypeSummaryResponseV5

Title: KitTypeSummaryResponseV5

Contains kit type summary response.

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

Nested Schema : KitTypeSummaryResponseV5

Type: object

Title: KitTypeSummaryResponseV5

Contains kit type summary response.

Show Source

kitTypes: array kitTypes

Title: kitTypes

Contains kit type summary.
maxKitNumber: integer (int32)

Maximum Kit number

Example: 5
maxSequenceNumber: integer (int32)

Kit maximum sequence number

Example: 5
minKitNumber: integer (int32)

Minimum Kit number

Example: 5
minSequenceNumber: integer (int32)

Kit minimum sequence number

Example: 5

{
    "title":"KitTypeSummaryResponseV5",
    "type":"object",
    "properties":{
        "kitTypes":{
            "title":"kitTypes",
            "type":"array",
            "description":"Contains kit type summary.",
            "items":{
                "$ref":"#/components/schemas/KitTypeSummaryTO"
            }
        },
        "minSequenceNumber":{
            "type":"integer",
            "description":"Kit minimum sequence number",
            "format":"int32",
            "example":5
        },
        "maxSequenceNumber":{
            "type":"integer",
            "description":"Kit maximum sequence number",
            "format":"int32",
            "example":5
        },
        "minKitNumber":{
            "type":"integer",
            "description":"Minimum Kit number",
            "format":"int32",
            "example":5
        },
        "maxKitNumber":{
            "type":"integer",
            "description":"Maximum Kit number",
            "format":"int32",
            "example":5
        }
    },
    "description":"Contains kit type summary response."
}

Nested Schema : kitTypes

Type: array

Title: kitTypes

Contains kit type summary.

Show Source

Array of: object KitTypeSummaryTOV3

Title: KitTypeSummaryTOV3

Contains kit type summary detail.

{
    "title":"kitTypes",
    "type":"array",
    "description":"Contains kit type summary.",
    "items":{
        "$ref":"#/components/schemas/KitTypeSummaryTO"
    }
}

Nested Schema : KitTypeSummaryTOV3

Type: object

Title: KitTypeSummaryTOV3

Contains kit type summary detail.

Show Source

description: string

Kit type description.

Example: Some description for kit
kitsAvailable: number (int)

Kits available
kitsConserved: number (BigDecimal)

Conserved kits
kitsDamaged: number (int)

Kit damaged

Example: 5
kitsDamagedBySubject: number (BigDecimal)

Kits damaged by subject
kitsDestroyed: number (BigDecimal)

Destroyed kits
kitsDispensed: number (int)

Kit dispensed

Example: 5
kitsExpired: number (int)

Kits Expired
kitsInTransit: number (int)

Kits In Transit
kitsLostBySubject: number (BigDecimal)

Kits lost by subject
kitsMisallocated: number (BigDecimal)

Kits Misallocated
kitsMissing: number (BigDecimal)

Missing kits
kitsNew: number (BigDecimal)

New kits
kitsNotDispensedToSubject: number (BigDecimal)

Kits not dispensed to subject
kitsNotInUse: number (BigDecimal)

Kits not in use
kitsPendingDestruction: number (int)

Kits Pending Destruction
kitsPreQuarantined: number (BigDecimal)

Kits in Pre Quarantined
kitsQuarantined: number (BigDecimal)

Kits in Quarantined
kitsReceivedForDestruction: number (BigDecimal)

Kits received for destruction
kitsRestrictedQuarantined: number (BigDecimal)

Kits in Restricted Quarantined
kitsReturnedToSite: number (int)

Kits Returned to Site
kitsTemporarilyUnavailable: number (BigDecimal)

Kits temporarily unavailable
kitTypeId: string (uuid)

ID of the kit type.
kitTypeName: string

Kit type name.

Example: Kit1001
kitTypeSrcId: string (uuid)

Designer Kit Id
packageType: string

Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

Package type

Example: BLISTERPACK
packageTypeId: number (BigDecimal)

Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

Example: 10
totalKitNumbers: number (int)

Total kit number

Example: 105
updatableKitsTotal: number (BigDecimal)

The total number of kits that can be updated

{
    "title":"KitTypeSummaryTOV3",
    "type":"object",
    "properties":{
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit1001"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Some description for kit"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"BigDecimal",
            "example":10
        },
        "packageType":{
            "type":"string",
            "description":"Package type",
            "example":"BLISTERPACK",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "totalKitNumbers":{
            "type":"number",
            "description":"Total kit number",
            "format":"int",
            "example":105
        },
        "kitsDispensed":{
            "type":"number",
            "description":"Kit dispensed",
            "format":"int",
            "example":5
        },
        "kitsDamaged":{
            "type":"number",
            "description":"Kit damaged",
            "format":"int",
            "example":5
        },
        "kitsAvailable":{
            "type":"number",
            "description":"Kits available",
            "format":"int"
        },
        "kitsInTransit":{
            "type":"number",
            "description":"Kits In Transit",
            "format":"int"
        },
        "kitsReturnedToSite":{
            "type":"number",
            "description":"Kits Returned to Site",
            "format":"int"
        },
        "kitsPendingDestruction":{
            "type":"number",
            "description":"Kits Pending Destruction",
            "format":"int"
        },
        "kitsExpired":{
            "type":"number",
            "description":"Kits Expired",
            "format":"int"
        },
        "kitsMisallocated":{
            "type":"number",
            "description":"Kits Misallocated",
            "format":"BigDecimal"
        },
        "kitsRestrictedQuarantined":{
            "type":"number",
            "description":"Kits in Restricted Quarantined",
            "format":"BigDecimal"
        },
        "kitsQuarantined":{
            "type":"number",
            "description":"Kits in Quarantined",
            "format":"BigDecimal"
        },
        "kitsPreQuarantined":{
            "type":"number",
            "description":"Kits in Pre Quarantined",
            "format":"BigDecimal"
        },
        "kitsDestroyed":{
            "type":"number",
            "description":"Destroyed kits",
            "format":"BigDecimal"
        },
        "kitsNotInUse":{
            "type":"number",
            "description":"Kits not in use",
            "format":"BigDecimal"
        },
        "kitsMissing":{
            "type":"number",
            "description":"Missing kits",
            "format":"BigDecimal"
        },
        "kitsLostBySubject":{
            "type":"number",
            "description":"Kits lost by subject",
            "format":"BigDecimal"
        },
        "kitsTemporarilyUnavailable":{
            "type":"number",
            "description":"Kits temporarily unavailable",
            "format":"BigDecimal"
        },
        "kitsDamagedBySubject":{
            "type":"number",
            "description":"Kits damaged by subject",
            "format":"BigDecimal"
        },
        "kitsNew":{
            "type":"number",
            "description":"New kits",
            "format":"BigDecimal"
        },
        "kitsNotDispensedToSubject":{
            "type":"number",
            "description":"Kits not dispensed to subject",
            "format":"BigDecimal"
        },
        "kitsConserved":{
            "type":"number",
            "description":"Conserved kits",
            "format":"BigDecimal"
        },
        "kitsReceivedForDestruction":{
            "type":"number",
            "description":"Kits received for destruction",
            "format":"BigDecimal"
        },
        "updatableKitsTotal":{
            "type":"number",
            "description":"The total number of kits that can be updated",
            "format":"BigDecimal"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Designer Kit Id",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        }
    },
    "description":"Contains kit type summary detail."
}

400 Response

Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filters OR Invalid kit type OR Invalid Lot OR Invalid location

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

404 Response

Invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object