Create partial dispensation settings
post
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings
Adds partial dispensation settings. Rights required:SupplySettingRightsPost.
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 : PartialDispensationRequest
Type:
objectTitle:
PartialDispensationRequestRequest containing partial dispensation settings
Show Source
-
enabled(required): boolean
EnabledExample:
true -
endingVisitInstanceNumber: number
Minimum Value:
1Maximum Value:999Ending Visit Instance NumberExample:10 -
endingVisitSrcId: string
(uuid)
Ending Visit Id
-
kitTypeSrcId: string
(uuid)
kitTypeSrcId of the kit
-
startingVisitInstanceNumber: number
Minimum Value:
1Maximum Value:999Starting 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:
objectTitle:
PartialDispensationResponseResponse 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:
objectCommon response object.
Show Source
-
errorData: object
ErrorResponseData
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success -
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type:
objectResult Object