Jump to

• Request
• Response

v1.0

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

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SupplySettingResponse

Type: object

Title: SupplySettingResponse

Contains supply setting response detail.

Show Source

• consignment: object Consignment
  Title: Consignment

  Contains consignment detail.
• initialShipments: object InitialShipments
  Title: InitialShipments

  Contains initial shipment detail.
• inventory: object InventorySchedule
  Title: InventorySchedule

  Contains inventory schedule details.
• kitOrdering: object KitOrdering
  Title: KitOrdering

  Contains kit ordering detail.
• labelGroups: string
  Label group.
• resupplyType: array Resupply Types
  Title: Resupply Types

  Resupply types.
• shippingGroups: string
  Shipping group.
• studyIdentifier: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example: B1B8327AFAA6412287106192AB5984EF
• studyVersionStart: string (date-time)
  Study version start.

{
    "title":"SupplySettingResponse",
    "type":"object",
    "properties":{
        "studyIdentifier":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time"
        },
        "initialShipments":{
            "$ref":"#/components/schemas/InitialShipments"
        },
        "resupplyType":{
            "title":"Resupply Types",
            "type":"array",
            "description":"Resupply types.",
            "items":{
                "$ref":"#/components/schemas/ResupplyType"
            }
        },
        "inventory":{
            "$ref":"#/components/schemas/InventorySchedule"
        },
        "kitOrdering":{
            "$ref":"#/components/schemas/KitOrdering"
        },
        "labelGroups":{
            "type":"string",
            "description":"Label group."
        },
        "shippingGroups":{
            "type":"string",
            "description":"Shipping group."
        },
        "consignment":{
            "$ref":"#/components/schemas/Consignment"
        }
    },
    "description":"Contains supply setting response detail."
}

Nested Schema : Consignment

Type: object

Title: Consignment

Contains consignment detail.

Show Source

• enableTemperatureExecursion: string
  Enable temperature excursion.
• notReceivedDaysToWaitBeforeSiteNotified: integer (int32)
  Days to wait before site to be notified.

  Example: 5
• siteCanRequestManual: string
  Site can request manual.

{
    "title":"Consignment",
    "type":"object",
    "properties":{
        "enableTemperatureExecursion":{
            "type":"string",
            "description":"Enable temperature excursion."
        },
        "notReceivedDaysToWaitBeforeSiteNotified":{
            "type":"integer",
            "description":"Days to wait before site to be notified.",
            "format":"int32",
            "example":5
        },
        "siteCanRequestManual":{
            "type":"string",
            "description":"Site can request manual."
        }
    },
    "description":"Contains consignment detail."
}

Nested Schema : InitialShipments

Type: object

Title: InitialShipments

Contains initial shipment detail.

Show Source

• visitNumber: integer (int64)
  Visit number.

  Example: 5
• whenToSend: string
  When to send initial shipment.

{
    "title":"InitialShipments",
    "type":"object",
    "properties":{
        "whenToSend":{
            "type":"string",
            "description":"When to send initial shipment."
        },
        "visitNumber":{
            "type":"integer",
            "description":"Visit number.",
            "format":"int64",
            "example":5
        }
    },
    "description":"Contains initial shipment detail."
}

Nested Schema : InventorySchedule

Type: object

Title: InventorySchedule

Contains inventory schedule details.

Show Source

• daysToRun: object DaysToRun
  Title: DaysToRun

  Days to run inventory detail.
• timeToRun: object TimeToRun
  Title: TimeToRun

  Time to run inventory detail.

{
    "title":"InventorySchedule",
    "type":"object",
    "properties":{
        "daysToRun":{
            "$ref":"#/components/schemas/DaysToRun"
        },
        "timeToRun":{
            "$ref":"#/components/schemas/TimeToRun"
        }
    },
    "description":"Contains inventory schedule details."
}

Nested Schema : KitOrdering

Type: object

Title: KitOrdering

Contains kit ordering detail.

Show Source

• allowed: string
  Allowed.
• blindingGroupsRequired: string
  Indicates whether blinding groups are required.
• kitsToPreventUnblinding: string
  Kits to prevent unblinding.
• kitType: string
  Kit type.

{
    "title":"KitOrdering",
    "type":"object",
    "properties":{
        "allowed":{
            "type":"string",
            "description":"Allowed."
        },
        "blindingGroupsRequired":{
            "type":"string",
            "description":"Indicates whether blinding groups are required."
        },
        "kitsToPreventUnblinding":{
            "type":"string",
            "description":"Kits to prevent unblinding."
        },
        "kitType":{
            "type":"string",
            "description":"Kit type."
        }
    },
    "description":"Contains kit ordering detail."
}

Nested Schema : Resupply Types

Type: array

Title: Resupply Types

Resupply types.

Show Source

• Array of: object ResupplyType
  Title: ResupplyType

  Contains resupply detail.

{
    "title":"Resupply Types",
    "type":"array",
    "description":"Resupply types.",
    "items":{
        "$ref":"#/components/schemas/ResupplyType"
    }
}

Nested Schema : DaysToRun

Type: object

Title: DaysToRun

Days to run inventory detail.

Show Source

• friday: boolean
  Is inventory to run on Friday.

  Example: true
• monday: boolean
  Is inventory to run on Monday.

  Example: true
• saturday: boolean
  Is inventory to run on Saturday.

  Example: true
• sunday: boolean
  Is inventory to run on Sunday.

  Example: true
• thursday: boolean
  Is inventory to run on Thursday.

  Example: true
• tuesday: boolean
  Is inventory to run on Tuesday.

  Example: true
• wednesday: boolean
  Is inventory to run on Wednesday.

  Example: true

{
    "title":"DaysToRun",
    "type":"object",
    "properties":{
        "sunday":{
            "type":"boolean",
            "description":"Is inventory to run on Sunday.",
            "example":true
        },
        "monday":{
            "type":"boolean",
            "description":"Is inventory to run on Monday.",
            "example":true
        },
        "tuesday":{
            "type":"boolean",
            "description":"Is inventory to run on Tuesday.",
            "example":true
        },
        "wednesday":{
            "type":"boolean",
            "description":"Is inventory to run on Wednesday.",
            "example":true
        },
        "thursday":{
            "type":"boolean",
            "description":"Is inventory to run on Thursday.",
            "example":true
        },
        "friday":{
            "type":"boolean",
            "description":"Is inventory to run on Friday.",
            "example":true
        },
        "saturday":{
            "type":"boolean",
            "description":"Is inventory to run on Saturday.",
            "example":true
        }
    },
    "description":"Days to run inventory detail."
}

Nested Schema : TimeToRun

Type: object

Title: TimeToRun

Time to run inventory detail.

Show Source

• timeHour: integer (int32)
  Time in hour.

  Example: 5
• timeMinute: integer (int32)
  Time in minute.

  Example: 5
• timePeriod: string
  Time period.
• timeZone: string
  Time zone.

{
    "title":"TimeToRun",
    "type":"object",
    "properties":{
        "timeHour":{
            "type":"integer",
            "description":"Time in hour.",
            "format":"int32",
            "example":5
        },
        "timeMinute":{
            "type":"integer",
            "description":"Time in minute.",
            "format":"int32",
            "example":5
        },
        "timePeriod":{
            "type":"string",
            "description":"Time period."
        },
        "timeZone":{
            "type":"string",
            "description":"Time zone."
        }
    },
    "description":"Time to run inventory detail."
}

Nested Schema : ResupplyType

Type: object

Title: ResupplyType

Contains resupply detail.

Show Source

• resupplyName: string
  Resupply name.
• resupplyType: string
  Resupply type.

{
    "title":"ResupplyType",
    "type":"object",
    "properties":{
        "resupplyName":{
            "type":"string",
            "description":"Resupply name."
        },
        "resupplyType":{
            "type":"string",
            "description":"Resupply type."
        }
    },
    "description":"Contains resupply detail."
}

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top