[Deprecated]: Update list of dispensation visits
put
/ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/dispensings
Deprecated: Use latest version instead. Updates list of dispensation visits in a study version to create new visits, update existing ones or delete deprecated visits.
Request
Path Parameters
-
studyId(required): string(uuid)
Study ID. Example: F054C951EB74443C93716CA714AB686E
-
version(required): string
Study version. Example: "1.0.0.1"
Query Parameters
-
randVisitId: string
Optional visit id where randomization was assigned.Default Value:
empty
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
array-
Array of:
object ArmKitVisitDto v3.0
Title:
ArmKitVisitDto v3.0Visit kit dispensation per treatment arm.
Nested Schema : ArmKitVisitDto v3.0
Type:
objectTitle:
ArmKitVisitDto v3.0Visit kit dispensation per treatment arm.
Show Source
-
allowTitration: boolean
Indicates if titration is allowed on the kit.Example:
false -
armid: string
(uuid)
Treatment Arm GUID
-
dispenseoutsidewindow: boolean
Kit can be dispensed outside the schedule window.Example:
false -
dnd: integer
(int64)
Do not Dispense - a number of days before kit expiration date when kit cannot be dispensed.Example:
5 -
dosingId: string
(uuid)
Dosing GUID
-
id: string
(uuid)
Dispensation GUID
-
kitid: string
(uuid)
Kit GUID
-
quantity: integer
(int64)
Kit quantity or dose.Example:
1 -
titrationKits: array
titrationKits
-
visitid: string
(uuid)
Visit GUID
Nested Schema : titrationKits
Type:
Show Source
array-
Array of:
object ArmKitVisitTitrationDto v3.0
Title:
ArmKitVisitTitrationDto v3.0Kit dispensations for a titration group.
Nested Schema : ArmKitVisitTitrationDto v3.0
Type:
objectTitle:
ArmKitVisitTitrationDto v3.0Kit dispensations for a titration group.
Show Source
-
kitid: string
(uuid)
Kit GUID
-
kitQuantity: integer
(int64)
Visit QuantityExample:
1 -
kitTypeId: string
Kit Type IdExample:
Kit A 20mg
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object RespArmKitVisitDto v3.0
Title:
RespArmKitVisitDto v3.0Error parameters list.
Nested Schema : RespArmKitVisitDto v3.0
Type:
objectTitle:
RespArmKitVisitDto v3.0Error parameters list.
Show Source
-
allowTitration: boolean
Indicates if titration is allowed on the kit.Example:
false -
armid: string
(uuid)
Treatment Arm GUID
-
dispenseoutsidewindow: boolean
Kit can be dispensed outside the schedule window.Example:
false -
dnd: integer
(int64)
Do not Dispense - a number of days before kit expiration date when kit cannot be dispensed.Example:
5 -
dosingId: string
(uuid)
Dosing GUID
-
errorParamList: array
errorParamList
-
id: string
(uuid)
Dispensation GUID
-
kitid: string
(uuid)
Kit GUID
-
quantity: integer
(int64)
Kit quantity or dose.Example:
1 -
titrationKits: array
titrationKits
-
visitid: string
(uuid)
Visit GUID
Nested Schema : errorParamList
Type:
Show Source
array-
Array of:
object RespErrParamListDto v1.0
Title:
RespErrParamListDto v1.0Error parameters list.
Nested Schema : titrationKits
Type:
Show Source
array-
Array of:
object ArmKitVisitTitrationDto v3.0
Title:
ArmKitVisitTitrationDto v3.0Kit dispensations for a titration group.
Nested Schema : RespErrParamListDto v1.0
Type:
objectTitle:
RespErrParamListDto v1.0Error parameters list.
Show Source
Nested Schema : ErrorParam
Type:
Show Source
array-
Array of:
object ErrorParam
Title:
ErrorParamError parameter
Nested Schema : ErrorParam
Type:
objectTitle:
ErrorParamError parameter
Show Source
-
id: string
(uuid)
Missing object unique GUID
-
key: string
(uuid)
Kit unique GUID
-
name: string
NameExample:
WEEK5 -
type: string
Missing object typeExample:
Visit
Nested Schema : ArmKitVisitTitrationDto v3.0
Type:
objectTitle:
ArmKitVisitTitrationDto v3.0Kit dispensations for a titration group.
Show Source
-
kitid: string
(uuid)
Kit GUID
-
kitQuantity: integer
(int64)
Visit QuantityExample:
1 -
kitTypeId: string
Kit Type IdExample:
Kit A 20mg
500 Response
Error
Nested Schema : details
Type:
object