Update partial dispensation settings of a given partial dispensation by ID
put
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}
Updates partial dispensation settings of a given partial dispensation definition 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 : PartialDispensationRequest
Type:
object
Title:
PartialDispensationRequest
Request containing partial dispensation settings
Show Source
-
enabled(required): boolean
EnabledExample:
true
-
endingVisitInstanceNumber: number
Minimum Value:
1
Maximum Value:999
Ending Visit Instance NumberExample:10
-
endingVisitSrcId: string
(uuid)
Ending Visit Id
-
kitTypeSrcId: string
(uuid)
kitTypeSrcId of the kit
-
startingVisitInstanceNumber: number
Minimum Value:
1
Maximum Value:999
Starting Visit Instance NumberExample:1
-
startingVisitSrcId(required): string
(uuid)
Starting Visit Id
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : PartialDispensationResponse
Type:
object
Title:
PartialDispensationResponse
Response containing partial dispensation settings
Show Source
-
comment: string
Comment
-
enabled: boolean
EnabledExample:
true
-
endingVisitInstanceNumber: number
Ending Visit Instance NumberExample:
3
-
endingVisitSrcId: string
(uuid)
Ending Visit Id
-
kitTypeSrcId: string
(uuid)
Kittypesrc id for each Kit
-
objectVersionNumber: number
(BigDecimal)
Object Version Number
-
operationType: string
operation Type
-
partialDispSettingId: string
(uuid)
-
reason: string
Reason
-
startingVisitInstanceNumber: number
Starting Visit Instance NumberExample:
1
-
startingVisitSrcId: string
(uuid)
Starting Visit Id
-
userId: string
(uuid)
User id for each User
-
versionEnd: string
(date-time)
Version End
-
versionStart: string
(date-time)
Version Start
400 Response
Invalid Partial Dispensation 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