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.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
array
-
Array of:
object KitDetailsExtTO_V2
Title:
KitDetailsExtTO_V2
Contains kit details plus some extended fields needed by IntHub service.
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 idExample:
9BD49A59E47E4383B98802712763FD43
-
blindedLotNumber: string
Blinded lot numberExample:
BLot1101
-
blockNumber: string
Block NumberExample:
1101
-
inventoryId: string
(uuid)
Unique id for inventory
-
inventoryStatus: string
Inventory statusExample:
Dispensed
-
inventoryStatusId: number
(BigDecimal)
Inventory status idExample:
10
-
kitNumber: number
(BigDecimal)
Kit number.Example:
10
-
kitNumberUTF: string
Kit Number with UTF8 supportExample:
KN1101
-
labelGroup: string
Label groupExample:
Labelgroup1001
-
labelGroupId: string
Label group idExample:
9BD49A59E47E4383B98802712763FD43
-
locationChangeList: array
locationChangeList
-
locationId: string
Location idExample:
1873CDF69E9B48B89B2D9E7951057D09
-
manufacturingLotExpirationDate: string
(date-time)
Manufacturing lot expiration date
-
manufacturingLotId: string
Manufactoring lot idExample:
9BD49A59E47E4383B98802712763FD43
-
manufacturingLotNumber: string
Manufactoring lot numberExample:
Mlot1001
-
prevBlindedLotNumber: string
Previous blinded lot numberExample:
BLot1101
-
prevInventoryStatus: string
Previous Inventory statusExample:
Dispensed
-
prevInventoryStatusId: number
(BigDecimal)
Previous inventory status idExample:
10
-
prevManufacturingLotNumber: string
Previous manufactoring lot numberExample:
Mlot1001
-
sequenceNumber: number
(BigDecimal)
Sequence numberExample:
10
Nested Schema : locationChangeList
Type:
Show Source
array
-
Array of:
object LocationUpdateTO
Title:
LocationUpdateTO
Contains location (site/depot) info.
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 idExample:
1873CDF69E9B48B89B2D9E7951057D09
400 Response
Invalid date range
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
Invalid study ID
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object