Update dose hold settings of a given dose hold by ID
put
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Updates dose hold settings of a given does hold identified by ID. Rights required:SupplySettingRightsPost
Request
Path Parameters
-
id(required): string
-
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 : DoseHoldRequest
Type:
object
Title:
DoseHoldRequest
Request containing dose hold settings
Show Source
-
enabled(required): boolean
EnabledExample:
true
-
endingVisitInstanceNumber: number
Minimum Value:
1
Maximum Value:999
Ending Visit Instance NumberExample:3
-
endingVisitSrcId: string
(uuid)
Ending Visit Id
-
frequencyLimitInDays: number
Minimum Value:
1
Maximum Value:999
Frequency LimitInDaysExample:800
-
frequencyLimitInSequence: number
Minimum Value:
1
Maximum Value:999
Frequency LimitInSequenceExample:800
-
frequencyUnlimited: boolean
FrequencyUnlimitedExample:
true
-
instanceNumber: number
Minimum Value:
1
Maximum Value:999
Instance NumberExample:5
-
kitTypeSrcId(required): string
(uuid)
Kit Type Id
-
maxDoseHolds: number
Minimum Value:
1
Maximum Value:999
Maximum DoseHoldsExample:800
-
startingVisitSrcId(required): string
(uuid)
Starting Visit Id
Response
Supported Media Types
- application/json
200 Response
Successful operation
400 Response
Invalid Dose Hold Setting Details
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