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
Title: ErrorResponseData
Error Response Details Information
Show Source
  • Object
    Title: Object
    Object with error details information.
  • Error code which is stored in ErrorCode enum. Example : C1-003
    Example: C1-003
  • Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved
    Example: Cannot modify object after a study version has been approved
Nested Schema : result
Type: object
Result Object
Nested Schema : Object
Type: object
Title: Object
Object with error details information.
Back to Top