[Deprecated]: Get kit summary by kit type ID
get
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Deprecated: Retrieves kit summary by kit type ID. In this API, kitNumber added in request to filter kits by kitNumber, fields blockNumber and kitNumberUTF added to return block number and kit number in UTF-8. Rights: OrsInventoryGet and OrsUnblinded.
Request
Path Parameters
-
kitTypeId(required): string
ID of the kit type.
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Query Parameters
-
kitNumber: string
Kit number
-
kitRange(required): string
Range of the kit
-
kitStatus(required): string
Status of the kit
-
labelGroupId(required): string
ID of the label group
-
limit: string
Maximum number of records to display per page.
-
location(required): string
Location of the kit
-
lotId(required): string
ID of the lot
-
offset: string
An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter
-
sortBy: string
Specify the parameter by which the kits are ordered. Default valus is 'SEQUENCE_NUMBER'Default Value:
SEQUENCE_NUMBER
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : KitDetailsResponse
Type:
object
Contains kit detail response.
Show Source
-
count: integer
(int64)
Total count of result
-
hasMore: boolean
Attribute describes if result set has more recordsExample:
true
-
kits: array
kits
-
kitTypeId: string
Kit type idExample:
B1B8327AFAA6412287106192AB5984EF
-
kitTypeName: string
Kit type nameExample:
Kit1001
-
limit: integer
(int64)
Maximum number of records to display per page.
-
links: array
links
-
maxKitNumber: integer
(int32)
Maximum Kit numberExample:
5
-
maxSequenceNumber: integer
(int32)
Kit maximum sequence numberExample:
5
-
minKitNumber: integer
(int32)
Minimum Kit numberExample:
5
-
minSequenceNumber: integer
(int32)
Kit minimum sequence numberExample:
5
-
offset: integer
(int64)
An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameterExample:
400
-
totalResults: integer
(int64)
Total number of entities in response
Nested Schema : kits
Type:
Show Source
array
-
Array of:
object KitDetailsTO
Title:
KitDetailsTO
Contains kit detail.
Nested Schema : KitDetailsTO
Type:
object
Title:
KitDetailsTO
Contains kit detail.
Show Source
-
blindedLotId: string
Blinded lot idExample:
9BD49A59E47E4383B98802712763FD43
-
blindedLotNumber: string
Blinded lot numberExample:
BLot1101
-
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
-
labelGroup: string
Label groupExample:
Labelgroup1001
-
labelGroupId: string
Label group idExample:
9BD49A59E47E4383B98802712763FD43
-
locationId: string
Location idExample:
1873CDF69E9B48B89B2D9E7951057D09
-
manufacturingLotId: string
Manufactoring lot idExample:
9BD49A59E47E4383B98802712763FD43
-
manufacturingLotNumber: string
Manufactoring lot numberExample:
Mlot1001
-
sequenceNumber: number
(BigDecimal)
Sequence numberExample:
10
Nested Schema : RelLink
Type:
object
Object contains link detail.
Show Source
-
href: string
Realtive URL
-
rel: string
link
400 Response
Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filtersOR Invalid kit type OR Invalid Lot OR Invalid location
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 or version or Kit type not found
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