Get kit details by order
get
/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Retrieves a kit's details by order. Rights: OrsInventoryGet, OrsUnblinded. Added new field: kitNumberUTF to 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
-
kitNumber(required): string
Kit/Lot number
-
orderBy(required): string
Specify the parameter by which the kits are ordered
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ShipmentKitsResponse v4.0
Type:
object
Title:
ShipmentKitsResponse v4.0
Response object containing shipment kits details.
Show Source
-
kitTypes: array
kitTypes
-
shipmentId: string
(uuid)
Shipment Id.
Nested Schema : kitTypes
Type:
Show Source
array
-
Array of:
object ShipmentKitsResponse.KitTypeSummary v4.0
Title:
ShipmentKitsResponse.KitTypeSummary v4.0
Kit type summary details object.
Nested Schema : ShipmentKitsResponse.KitTypeSummary v4.0
Type:
object
Title:
ShipmentKitsResponse.KitTypeSummary v4.0
Kit type summary details object.
Show Source
-
description: string
Kit type description.Example:
Non dosing kit
-
id: string
(uuid)
ID of the kit type.
-
kits: array
kits
-
kitTypeName: string
Kit type name.Example:
Kit A
-
kitTypeSrcId: string
(uuid)
ID of the kit.
-
nsKits: array
nsKits
-
packageTypeId: number
(double)
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ]
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:5
-
packageTypeKey: string
Allowed Values:
[ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]
Package type key.Example:INHALER
-
unitsPerKit: number
(double)
Number of units perkit.Example:
5
Nested Schema : kits
Type:
Show Source
array
-
Array of:
object ShipmentKitsResponse.Kit v5.0
Title:
ShipmentKitsResponse.Kit v5.0
Kit details object.
Nested Schema : nsKits
Type:
Show Source
array
-
Array of:
object ShipmentKitsResponse.NonSerialized v5.0
Title:
ShipmentKitsResponse.NonSerialized v5.0
Kit details object.
Nested Schema : ShipmentKitsResponse.Kit v5.0
Type:
object
Title:
ShipmentKitsResponse.Kit v5.0
Kit details object.
Show Source
-
barcode: string
BarcodeExample:
Kit A
-
depotReturnedUnits: number
(double)
Number of units returned to depot.Example:
5
-
id: string
(uuid)
Kit Id.
-
inventoryStatusId: number
(double)
Inventory statusIdExample:
5
-
itemNumber: string
Item NumberExample:
ItemNumber0000001
-
kitNumber: number
(double)
Kit number.Example:
5
-
kitNumberUTF: string
Kit number in utf-8Example:
12345
-
materialId: string
MaterialId IdExample:
MaterialId0000001
-
missingUnits: number
(double)
Missing units.Example:
5
-
returnedUnits: number
(double)
Returned units.Example:
5
-
sequenceNumber: number
(double)
Sequence number.Example:
5
Nested Schema : ShipmentKitsResponse.NonSerialized v5.0
Type:
object
Title:
ShipmentKitsResponse.NonSerialized v5.0
Kit details object.
Show Source
-
id: string
(uuid)
NonSerialized lot Id.
-
inventoryStatusId: number
(double)
Inventory statusIdExample:
5
-
Lot number: string
Lot assigned to non serialized kitsExample:
Lot 1
-
quantity: number
Kit quantityExample:
1
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