Search kits by kit type or shipment details
get
/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
Searches for kits by kit type or shipment details. Rights: OrsInventoryGet, OrsUnblinded. Added additional field kitNumberUTF in the response
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
shipmentId(required): string(uuid)
ID of the shipment.
-
studyId(required): string(uuid)
ID of the study
Query Parameters
-
kitTypeId(required): string(uuid)
ID of the kit type.
-
limit: string
Maximum number of records to display per page.Default Value:
100
-
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 parameterDefault Value:
0
-
searchString(required): string
Search string
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ShipmentEligibleKitsResponse v2.0
Type:
object
Title:
ShipmentEligibleKitsResponse v2.0
Response object containing kits belonging to shipment.
Show Source
-
count: integer
(int64)
Total count of result
-
hasMore: boolean
Attribute describes if result set has more recordsExample:
true
-
kits: array
kits
-
limit: integer
(int64)
Maximum number of records to display per page.
-
links: array
links
-
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
-
shipmentId: string
(uuid)
Shipment Id.
-
totalResults: integer
(int64)
Total number of entities in response
Nested Schema : kits
Type:
Show Source
array
-
Array of:
object ShipmentEligibleKitTO v2.0
Title:
ShipmentEligibleKitTO v2.0
Contains kit details belonging to shipment.
Nested Schema : ShipmentEligibleKitTO v2.0
Type:
object
Title:
ShipmentEligibleKitTO v2.0
Contains kit details belonging to shipment.
Show Source
-
expirationDate: string
(date-time)
Expiration date
-
id: string
(uuid)
Inventory Id.
-
kitNumber: number
(double)
Kit/Lot numberExample:
5
-
kitNumberUTF: string
Kit number in utf-8 encodingExample:
12345ab
-
kitTypeName: string
Kit type name.Example:
Kit A
-
sequenceNumber: number
(double)
Sequence number.Example:
5
-
srcId: string
(uuid)
kitType src Id.
Nested Schema : RelLink
Type:
object
Object contains link detail.
Show Source
-
href: string
Realtive URL
-
rel: string
link
404 Response
'Invalid study ID', 'Study still in design phase' or 'Invalid shipment ID'
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
500 Response
Internal server error
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object