Get a resupply group by ID
get
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Retrieves a resupply group by ID. Rights: SupplySettingRightsGet. Required sponsor roles are clinical supply manager and site manager.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
resupplyId(required): string(uuid)
ID of resupply group
-
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
Nested Schema : resupplies
Type:
Show Source
array
-
Array of:
object ResupplyGroup
Resupply group details.
Nested Schema : ResupplyGroup
Type:
object
Resupply group details.
Show Source
-
id: string
(uuid)
Resupply Id
-
kitTypes: array
kitTypes
-
resupplyName: string
Resupply nameExample:
Resupply 1
-
resupplyTypeId: number
(Integer)
Id of the resupply type.Example:
2
Nested Schema : kitTypes
Type:
Show Source
array
-
Array of:
object ResupplyGroupResponse.KitTypeSummary
Kit type summary details object.
Nested Schema : ResupplyGroupResponse.KitTypeSummary
Type:
object
Kit type summary details object.
Show Source
-
description: string
Kit type description.Example:
Non dosing kit
-
id: string
ID of the kit type.Example:
kitA
-
initialShippingUnits: number
(double)
The number of kits of each type that are in the initial shipment.Example:
50
-
kitTypeName: string
Kit type name.Example:
Kit A
-
manualConsignment: number
(double)
The number of kits of each type that are included in a manual shipment.Example:
50
-
maxBuffer: number
(double)
The number of kits that will be present at the site after a resupply shipment arrives.Example:
50
-
minBuffer: number
(double)
The number of kits that trigger a shipment when the resupply strategy runs.Example:
5
-
packageTypeId: number
(double)
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ]
Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).Example:5
-
resupplyWeeks: number
(double)
The number of weeks that the resupply strategy resupplies for.Example:
3
-
triggerWeeks: number
(double)
The number of weeks that the resupply strategy looks out to determine the supply.Example:
3
404 Response
Resupply not found.
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
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