Update supply settings
put
/ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/supply/settings
Updates a study's supply settings by study ID. Rights: SupplySettingRightsPost. Required sponsor roles are: clinical supply manager and site manager. Added new field: dispenseByLowestKitNumber in Request.
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 : SupplySettingsTO v7.0
Type:
object
Title:
SupplySettingsTO v7.0
Supply settings details object.
Show Source
-
allowBarcodeScan(required): boolean
Indicate whether barcode scan is allowed.Example:
true
-
allowDoseHold(required): boolean
AllowDoseHoldExample:
true
-
allowManualConsignments(required): boolean
Indicate whether to allow manual consignments.Example:
true
-
allowPartialDispensation(required): boolean
Indicate whether partial dispensation is allowed.Example:
true
-
allowSingleKitQuarantine(required): boolean
Indicate whether to allow single kit quarantine.Example:
true
-
customShipmentIdPrefix: string
Custom shipment id prefix when shipment prefix type is CUSTOM.Example:
SomePrefix
-
depotKitReconRequired(required): boolean
Depot kit reconciliation required.Example:
true
-
dispenseByLowestKitNumber(required): boolean
DispenseByLowestKitNumberExample:
true
-
intlShipmentTriggerId(required): number
(double)
Initial shipment trigger Id.Example:
2
-
intlShipmentVisitId: string
(uuid)
Initial shipment visit Id
-
kitReconciliationRequired(required): boolean
Indicate whether kit reconciliation is required.Example:
true
-
quarantineWithoutTempMonitor(required): boolean
quarantineWithoutTempMonitorExample:
false
-
reuseOnlyLastVisitKkits(required): boolean
Indicate whether to reuse only last visit kits.Example:
true
-
reuseSealedKits(required): boolean
Indicate whether to reuse sealed kits.Example:
true
-
sendKitTypeForSingleKitOrder: string
(uuid)
Default kit type Id
-
shipmentPrefixType(required): string
Allowed Values:
[ "DEPOTID", "CUSTOM", "NONE" ]
Shipment prefix type.Example:DEPOTID
-
singleKitSettingId: number
(double)
Single kit setting Id.Example:
1
-
useBlindingGroups(required): boolean
Indicate whether to use blinding groups.Example:
true
-
useLabelGroups(required): boolean
Indicate whether to use label groups.Example:
true
-
useShippingGroups(required): boolean
Indicate whether to use shipping groups.Example:
true
-
useTemperatureExcursion(required): boolean
Indicate whether to use temperature excursion.Example:
true
-
waitDaysBeforeNotifying: number
(double)
Minimum Value:
0
Maximum Value:30
Number of days after the ship date (or the raise date, if the ship date isn't defined) when a site user receives a notification to mark a shipment as received.Example:2
Response
Supported Media Types
- application/json
200 Response
Successful operation
400 Response
Invalid shipment OR Invalid Kit status OR One or more shipment are not in valid status OR Custom shipment prefix should be of length between 1 to 10 and contains only alphanumerics OR Invalid shipment prefix type.
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
Not found
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