Update kit status
put
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/status
Updates kit status. Rights: OrsInventoryPost 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
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Request object for kit status.
Show Source
-
inventoryStatusId(required): integer
(int32)
Inventory status idExample:
5
-
kitFilters: object
KitFiltersRequest
Kit filter request
-
kits: array
kits
Title:
kits
Kit id. -
reason: string
Minimum Length:
0
Maximum Length:255
Reason of updateExample:kit damaged by subject
Nested Schema : KitFiltersRequest
Type:
object
Kit filter request
Show Source
-
blockNumber: string
blockNumberExample:
1
-
kitNumber: string
Kit NumberExample:
abc-2
-
kitRange: string
Kit rangeExample:
SEQUENCE_NUMBER:900:1200
-
kitStatus: string
Kit status idExample:
1
-
kitTypeIds: array
kitTypeIds
kitTypeIds
-
labelGroupId: string
Label group idExample:
B1B8327AFAA6412287106192AB5984EF
-
location: string
LocationExample:
ALL_SITES
-
lotId: string
Lot idExample:
B1B8327AFAA6412287106192AB5984EF
-
tempExcursionNumber: string
tempExcursionNumberExample:
1
Nested Schema : kitTypeIds
Type:
array
kitTypeIds
Show Source
-
Array of:
string(uuid)
kitTypeIds
Example:
[
"3F6567865E694182BEEA2B4F76538F05",
"461A0B8261454C1EBA56285BB538E7B5",
"EB2B77004EF74E479B6DDBA56D8B6A51"
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
400 Response
Invalid kit OR Specify at least one filter OR Either kits or kitFilters is required OR Invalid Inventory Status OR All kits should have same inventory status OR Invalid inventory status transition
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