Get study settings
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings
Retrieves the study settings for a given study and mode. Rights: OrsInventoryGet.
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 : SupplySettingResponse
Type:
object
Contains supply setting response detail.
Show Source
-
consignment: object
Consignment
Contains Consignment detail
-
initialShipments: object
InitialShipments
Contains initial shipment detail.
-
inventory: object
InventorySchedule
Contains Inventory schedule details.
-
kitOrdering: object
KitOrdering
Contains Kit ordering detail
-
labelGroups: string
Label group
-
resupplyType: array
resupplyType
-
shippingGroups: string
Shipping group
-
studyIdentifier: string
ID of the studyExample:
B1B8327AFAA6412287106192AB5984EF
-
studyVersionStart: string
(date-time)
Study version start
Nested Schema : Consignment
Type:
object
Contains Consignment detail
Show Source
-
enableTemperatureExecursion: string
Enable temperature execursion
-
notReceivedDaysToWaitBeforeSiteNotified: integer
(int32)
Days to wait before site to be notified.Example:
5
-
siteCanRequestManual: string
Site cancel request manual
Nested Schema : InitialShipments
Type:
object
Contains initial shipment detail.
Show Source
-
visitNumber: integer
(int64)
Visit number.Example:
5
-
whenToSend: string
Nested Schema : InventorySchedule
Type:
object
Contains Inventory schedule details.
Show Source
-
daysToRun: object
DaysToRun
Days to run inventory detail.
-
timeToRun: object
TimeToRun
Time to run inventory detail.
Nested Schema : KitOrdering
Type:
object
Contains Kit ordering detail
Show Source
-
allowed: string
Allowed
-
blindingGroupsRequired: string
Is Blinding groups required
-
kitsToPreventUnblinding: string
Kits to prevent unblinding
-
kitType: string
Kit type
Nested Schema : resupplyType
Type:
Show Source
array
-
Array of:
object ResupplyType
Contains resupply detail.
Nested Schema : DaysToRun
Type:
object
Days to run inventory detail.
Show Source
-
friday: boolean
Is inventory to run on FridayExample:
true
-
monday: boolean
Is inventory to run on MondayExample:
true
-
saturday: boolean
Is inventory to run on SaturdayExample:
true
-
sunday: boolean
Is inventory to run on SundayExample:
true
-
thursday: boolean
Is inventory to run on ThursdayExample:
true
-
tuesday: boolean
Is inventory to run on TuesdayExample:
true
-
wednesday: boolean
Is inventory to run on WednesdayExample:
true
Nested Schema : TimeToRun
Type:
object
Time to run inventory detail.
Show Source
-
timeHour: integer
(int32)
Time in hour.Example:
5
-
timeMinute: integer
(int32)
Time in minute.Example:
5
-
timePeriod: string
Time period
-
timeZone: string
Time zone
Nested Schema : ResupplyType
Type:
object
Contains resupply detail.
Show Source
-
resupplyName: string
Resupply name
-
resupplyType: string
Resupply type
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