Get kit summary
get
/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types
Retrieves a kit's summary. 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
-
kitRange(required): string
Range of the kit
-
kitStatus(required): string
Status of the kit
-
kitTypeId(required): string
ID of the kit type.
-
labelGroupId(required): string
ID of the label group
-
location(required): string
Location of the kit
-
lotId(required): string
ID of the lot
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 KitTypeSummaryResponseV3
Title:
KitTypeSummaryResponseV3
Contains kit type summary response.
Nested Schema : KitTypeSummaryResponseV3
Type:
object
Title:
KitTypeSummaryResponseV3
Contains kit type summary response.
Show Source
-
kitTypes: array
kitTypes
Title:
kitTypes
Contains kit type summary.
Nested Schema : kitTypes
Type:
array
Title:
kitTypes
Contains kit type summary.
Show Source
-
Array of:
object KitTypeSummaryTOV3
Title:
KitTypeSummaryTOV3
Contains kit type summary detail.
Nested Schema : KitTypeSummaryTOV3
Type:
object
Title:
KitTypeSummaryTOV3
Contains kit type summary detail.
Show Source
-
description: string
Kit type description.Example:
Some description for kit
-
kitsAvailable: integer
(int32)
Kits available
-
kitsDamaged: integer
(int32)
Kit damagedExample:
5
-
kitsDispensed: integer
(int32)
Kit dispensedExample:
5
-
kitsExpired: integer
(int32)
Kits Expired
-
kitsInTransit: integer
(int32)
Kits In Transit
-
kitsPendingDestruction: integer
(int32)
Kits Pending Destruction
-
kitsReturnedToSite: integer
(int32)
Kits Returned to Site
-
kitTypeId: string
(uuid)
ID of the kit type.
-
kitTypeName: string
Kit type name.Example:
Kit1001
-
packageType: string
Allowed Values:
[ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]
Package typeExample:BLISTERPACK
-
packageTypeId: number
(BigDecimal)
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:
10
-
totalKitNumbers: integer
(int32)
Total kit numberExample:
105
400 Response
Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filters OR 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
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