Get supply settings
get
/ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings
Retrieves supply settings. Rights: SupplySettingRightsGet. Required sponsor roles are: clinical supply manager and site manager. Added new field: confirmDispensation in Response.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : SupplySettingsTO v9.0
Type:
object
Title:
SupplySettingsTO v9.0
Supply settings details object.
Show Source
-
allKitsSelectedForRandomization(required): boolean
allKitsSelectedForRandomizationExample:
false
-
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
-
kitsSelectedForRandomization: array
kitsSelectedForRandomization
kitsSelectedForRandomization.
-
quarantineWithoutTempMonitor(required): boolean
quarantineWithoutTempMonitorExample:
false
-
randomizeWhenKitsAvailable(required): boolean
randomizeWhenKitsAvailableExample:
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
-
sendNotificationOnce: boolean
sendNotificationOnceExample:
false
-
shipmentPrefixType(required): string
Allowed Values:
[ "DEPOTID", "CUSTOM", "NONE" ]
Shipment prefix type.Example:DEPOTID
-
singleKitSettingId: number
(double)
Single kit setting Id.Example:
1
-
tempExcursionStartingNumber: string
tempExcursionStartingNumber.Example:
12,13
-
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
Nested Schema : kitsSelectedForRandomization
Type:
array
kitsSelectedForRandomization.
Show Source
-
Array of:
string(uuid)
kitsSelectedForRandomization.
Example:
[
"30100000600000000000000000000000",
"40100000600000000000000000000000"
]
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