Generate kits
post
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/generate
Generates kits. Rights: DesignerKitListPost.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
description: string
Minimum Length:
0
Maximum Length:2000
Description of kitExample:Some discription of kit
-
kitNumberStart(required): integer
(int64)
Minimum Value:
1
Maximum Value:99999999
Kit number start value.Example:5
-
kitTypes(required): array
kitTypes
Minimum Number of Items:
1
Maximum Number of Items:2147483647
-
sequenceNumberStart(required): integer
(int64)
Minimum Value:
1
Maximum Value:99999999
Sequence number start.Example:5
-
title(required): string
Minimum Length:
1
Maximum Length:64
Title of kitExample:Comparative Cream--B
-
useKitNumberForBarcode: boolean
Use kit number for barcodeExample:
true
-
useRandomNumberForBarcode: boolean
Use random number for barcodeExample:
true
Nested Schema : kitTypes
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2147483647
-
Array of:
object KitTypeQuantityTO
Kit quantity object.
Nested Schema : KitTypeQuantityTO
Type:
object
Kit quantity object.
Show Source
-
kitTypeId(required): string
(uuid)
ID of the kit type.
-
kitTypeVersionStart: string
(date-time)
Kit type version start
-
quantity(required): integer
(int64)
Minimum Value:
1
Maximum Value:500000
Kit quantity.Example:5
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : InventoryStatus
Type:
object
Inventory status
Show Source
-
inventoryStatus: string
Allowed Values:
[ "Available", " Damaged", " Destroyed", " Dispensed", " Expired", " Not in Use", " Misallocated", " Missing", " In Transit", " Quarantined", " Pre-quarantined", " Pending Destruction", " Lost by Subject", " Temporarily Unavailable", " Damaged by Subject", " New", " Not Dispensed to Subject", " Returned to Site", " Conserved", "Received for Destruction" ]
Inventory statusExample:New, Damaged
-
inventoryStatusId: integer
(int64)
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]
Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).
400 Response
The title has already been used OR Invalid kit type OR The maximum number of rows requested shall not exceed 500000 OR Some numbers in this list are used in another kit list. Adjust the first kit or sequence number to that the values don't overlap with existing numbers. OR 1 or more sequence numbers already exist OR 1 or more kit numbers already exist OR The CSV might contain duplicate kit number(s) or sequence number(s)
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