Get study settings

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings

Retrieves the study settings for a given study and mode. Rights: OrsInventoryGet.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : SupplySettingResponse
Type: object
Contains supply setting response detail.
Show Source
Nested Schema : Consignment
Type: object
Contains Consignment detail
Show Source
Nested Schema : InitialShipments
Type: object
Contains initial shipment detail.
Show Source
Nested Schema : InventorySchedule
Type: object
Contains Inventory schedule details.
Show Source
Nested Schema : KitOrdering
Type: object
Contains Kit ordering detail
Show Source
Nested Schema : resupplyType
Type: array
Show Source
Nested Schema : DaysToRun
Type: object
Days to run inventory detail.
Show Source
Nested Schema : TimeToRun
Type: object
Time to run inventory detail.
Show Source
Nested Schema : ResupplyType
Type: object
Contains resupply detail.
Show Source

500 Response

Internal server error
Body ()
Root Schema : ORSResponse
Type: object
Common response object.
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • 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
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Result Object
Back to Top