REST API for Clinical One Platform

Get list of filtered kits

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/qualified-kits

Retrieves list of kits which had qualified recent updates based on criteria defined by Oracle Clinical One Integration Hub. In this API, blockNumber and kitNumberUTF added to return block number and kit number in UTF-8. 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

endDate(required): string

End date/time for looking and fetching qualified Kit updates
startDate(required): string

Start date/time for looking and fetching qualified Kit updates

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 KitDetailsExtTO_V2

Title: KitDetailsExtTO_V2

Contains kit details plus some extended fields needed by IntHub service.

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

Nested Schema : KitDetailsExtTO_V2

Type: object

Title: KitDetailsExtTO_V2

Contains kit details plus some extended fields needed by IntHub service.

Show Source

blindedLotExpirationDate: string (date-time)

Blinded lot expiration date
blindedLotId: string

Blinded lot id

Example: 9BD49A59E47E4383B98802712763FD43
blindedLotNumber: string

Blinded lot number

Example: BLot1101
blockNumber: string

Block Number

Example: 1101
inventoryId: string (uuid)

Unique id for inventory
inventoryStatus: string

Inventory status

Example: Dispensed
inventoryStatusId: number (BigDecimal)

Inventory status id

Example: 10
kitNumber: number (BigDecimal)

Kit number.

Example: 10
kitNumberUTF: string

Kit Number with UTF8 support

Example: KN1101
labelGroup: string

Label group

Example: Labelgroup1001
labelGroupId: string

Label group id

Example: 9BD49A59E47E4383B98802712763FD43
locationChangeList: array locationChangeList
locationId: string

Location id

Example: 1873CDF69E9B48B89B2D9E7951057D09
manufacturingLotExpirationDate: string (date-time)

Manufacturing lot expiration date
manufacturingLotId: string

Manufactoring lot id

Example: 9BD49A59E47E4383B98802712763FD43
manufacturingLotNumber: string

Manufactoring lot number

Example: Mlot1001
prevBlindedLotNumber: string

Previous blinded lot number

Example: BLot1101
prevInventoryStatus: string

Previous Inventory status

Example: Dispensed
prevInventoryStatusId: number (BigDecimal)

Previous inventory status id

Example: 10
prevManufacturingLotNumber: string

Previous manufactoring lot number

Example: Mlot1001
sequenceNumber: number (BigDecimal)

Sequence number

Example: 10

{
    "title":"KitDetailsExtTO_V2",
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"BigDecimal",
            "example":10
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number",
            "format":"BigDecimal",
            "example":10
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory status id",
            "format":"BigDecimal",
            "example":10
        },
        "locationId":{
            "type":"string",
            "description":"Location id",
            "example":"1873CDF69E9B48B89B2D9E7951057D09"
        },
        "manufacturingLotId":{
            "type":"string",
            "description":"Manufactoring lot id",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "blindedLotId":{
            "type":"string",
            "description":"Blinded lot id",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group id",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "inventoryStatus":{
            "type":"string",
            "description":"Inventory status",
            "example":"Dispensed"
        },
        "manufacturingLotNumber":{
            "type":"string",
            "description":"Manufactoring lot number",
            "example":"Mlot1001"
        },
        "blindedLotNumber":{
            "type":"string",
            "description":"Blinded lot number",
            "example":"BLot1101"
        },
        "labelGroup":{
            "type":"string",
            "description":"Label group",
            "example":"Labelgroup1001"
        },
        "manufacturingLotExpirationDate":{
            "type":"string",
            "description":"Manufacturing lot expiration date",
            "format":"date-time"
        },
        "blindedLotExpirationDate":{
            "type":"string",
            "description":"Blinded lot expiration date",
            "format":"date-time"
        },
        "prevInventoryStatusId":{
            "type":"number",
            "description":"Previous inventory status id",
            "format":"BigDecimal",
            "example":10
        },
        "prevInventoryStatus":{
            "type":"string",
            "description":"Previous Inventory status",
            "example":"Dispensed"
        },
        "locationChangeList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LocationUpdateTO"
            }
        },
        "prevManufacturingLotNumber":{
            "type":"string",
            "description":"Previous manufactoring lot number",
            "example":"Mlot1001"
        },
        "prevBlindedLotNumber":{
            "type":"string",
            "description":"Previous blinded lot number",
            "example":"BLot1101"
        },
        "blockNumber":{
            "type":"string",
            "description":"Block Number",
            "example":"1101"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit Number with UTF8 support",
            "example":"KN1101"
        },
        "inventoryId":{
            "type":"string",
            "description":"Unique id for inventory",
            "format":"uuid"
        }
    },
    "description":"Contains kit details plus some extended fields needed by IntHub service."
}

Nested Schema : locationChangeList

Type: array

Show Source

Array of: object LocationUpdateTO

Title: LocationUpdateTO

Contains location (site/depot) info.

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

Nested Schema : LocationUpdateTO

Type: object

Title: LocationUpdateTO

Contains location (site/depot) info.

Show Source

locationChangeDate: string (date-time)

Date when inventory site/deopt changed
locationId: string

Location id

Example: 1873CDF69E9B48B89B2D9E7951057D09

{
    "title":"LocationUpdateTO",
    "type":"object",
    "properties":{
        "locationId":{
            "type":"string",
            "description":"Location id",
            "example":"1873CDF69E9B48B89B2D9E7951057D09"
        },
        "locationChangeDate":{
            "type":"string",
            "description":"Date when inventory site/deopt changed",
            "format":"date-time"
        }
    },
    "description":"Contains location (site/depot) info."
}

400 Response

Invalid date range

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

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