Jump to

• Request
• Response

v4.0

get

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

Deprecated: Retrieves a study's supply settings by study ID. This version includes new field confirmDispensation in Response.
Required sponsor roles are: clinical supply manager and site manager.
Rights: SupplySettingRightsGet.

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 : SupplySettingsTO v4.0

Type: object

Title: SupplySettingsTO v4.0

Supply settings details object.

Show Source

• allowManualConsignments(required): boolean
  Title: Allow Manual Consignments

  Indicates whether manual consignments are allowed.

  Example: true
• allowPartialDispensation(required): boolean
  Indicate whether partial dispensation is allowed.

  Example: true
• allowSingleKitQuarantine(required): boolean
  Title: Allow Single Kit Quarantine

  Indicates whether single kit quarantine is allowed.

  Example: true
• confirmDispensation(required): boolean
  Title: Confirm Dispensation

  Indicates whether dispensation confirmation is required.

  Example: true
• customShipmentIdPrefix: string
  Title: Shipment ID Prefix

  Prefix used while generating shipment IDs.

  Example: SomePrefix
• intlShipmentTriggerId(required): number (double)
  Initial shipment trigger Id.

  Example: 2
• intlShipmentVisitId: string (uuid)
  Title: Initial Shipment Visit ID

  Identifier of the visit for initial shipments.
• kitReconciliationRequired(required): boolean
  Title: Site Kit Reconciliation Required

  Indicates whether kit reconciliation is required at the site.

  Example: true
• reuseOnlyLastVisitKkits(required): boolean
  Indicate whether to reuse only last visit kits.

  Example: true
• reuseSealedKits(required): boolean
  Indicate whether to reuse sealed kits.

  Example: true
• sendKitTypeForSingleKitOrder: string (uuid)
  Title: Kit Type ID

  Identifier of the selected kit type for single kit ordering.
• shipmentPrefixType(required): string
  Title: Shipment ID Prefix Type

  Allowed Values: [ "DEPOTID", "CUSTOM", "NONE" ]

  Type identifier used when generating shipment ID prefixes.

  Example: DEPOTID
• singleKitSettingId: number (double)
  Title: Single Kit Setting ID

  Identifier of the single kit ordering setting.

  Example: 1
• useBlindingGroups(required): boolean
  Title: Blinded Groups Required

  Indicates whether blinding groups are required.

  Example: true
• useLabelGroups(required): boolean
  Title: Label Groups Required

  Indicates whether label groups are required.

  Example: true
• useShippingGroups(required): boolean
  Title: Multiple Storage Requirements

  Indicates whether multiple storage/shipping requirement groups are used.

  Example: true
• useTemperatureExcursion(required): boolean
  Title: Allow Temperature Excursions

  Indicates whether temperature excursions are allowed.

  Example: true
• waitDaysBeforeNotifying: number (double)
  Title: Notification To Receive Shipment (in days)

  Minimum Value: 0

  Maximum Value: 30

  Number of days before a notification is sent to receive a shipment.

  Example: 2

{
    "title":"SupplySettingsTO v4.0",
    "required":[
        "allowManualConsignments",
        "allowPartialDispensation",
        "allowSingleKitQuarantine",
        "confirmDispensation",
        "intlShipmentTriggerId",
        "kitReconciliationRequired",
        "reuseOnlyLastVisitKkits",
        "reuseSealedKits",
        "shipmentPrefixType",
        "useBlindingGroups",
        "useLabelGroups",
        "useShippingGroups",
        "useTemperatureExcursion"
    ],
    "type":"object",
    "properties":{
        "useBlindingGroups":{
            "title":"Blinded Groups Required",
            "type":"boolean",
            "description":"Indicates whether blinding groups are required.",
            "example":true
        },
        "useLabelGroups":{
            "title":"Label Groups Required",
            "type":"boolean",
            "description":"Indicates whether label groups are required.",
            "example":true
        },
        "useShippingGroups":{
            "title":"Multiple Storage Requirements",
            "type":"boolean",
            "description":"Indicates whether multiple storage/shipping requirement groups are used.",
            "example":true
        },
        "useTemperatureExcursion":{
            "title":"Allow Temperature Excursions",
            "type":"boolean",
            "description":"Indicates whether temperature excursions are allowed.",
            "example":true
        },
        "allowSingleKitQuarantine":{
            "title":"Allow Single Kit Quarantine",
            "type":"boolean",
            "description":"Indicates whether single kit quarantine is allowed.",
            "example":true
        },
        "allowManualConsignments":{
            "title":"Allow Manual Consignments",
            "type":"boolean",
            "description":"Indicates whether manual consignments are allowed.",
            "example":true
        },
        "singleKitSettingId":{
            "title":"Single Kit Setting ID",
            "type":"number",
            "description":"Identifier of the single kit ordering setting.",
            "format":"double",
            "example":1
        },
        "sendKitTypeForSingleKitOrder":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Identifier of the selected kit type for single kit ordering.",
            "format":"uuid"
        },
        "intlShipmentTriggerId":{
            "type":"number",
            "description":"Initial shipment trigger Id.",
            "format":"double",
            "example":2
        },
        "intlShipmentVisitId":{
            "title":"Initial Shipment Visit ID",
            "type":"string",
            "description":"Identifier of the visit for initial shipments.",
            "format":"uuid"
        },
        "waitDaysBeforeNotifying":{
            "title":"Notification To Receive Shipment (in days)",
            "maximum":30,
            "minimum":0,
            "type":"number",
            "description":"Number of days before a notification is sent to receive a shipment.",
            "format":"double",
            "example":2
        },
        "shipmentPrefixType":{
            "title":"Shipment ID Prefix Type",
            "type":"string",
            "description":"Type identifier used when generating shipment ID prefixes.",
            "example":"DEPOTID",
            "enum":[
                "DEPOTID",
                "CUSTOM",
                "NONE"
            ]
        },
        "customShipmentIdPrefix":{
            "title":"Shipment ID Prefix",
            "type":"string",
            "description":"Prefix used while generating shipment IDs.",
            "example":"SomePrefix"
        },
        "kitReconciliationRequired":{
            "title":"Site Kit Reconciliation Required",
            "type":"boolean",
            "description":"Indicates whether kit reconciliation is required at the site.",
            "example":true
        },
        "reuseSealedKits":{
            "type":"boolean",
            "description":"Indicate whether to reuse sealed kits.",
            "example":true
        },
        "reuseOnlyLastVisitKkits":{
            "type":"boolean",
            "description":"Indicate whether to reuse only last visit kits.",
            "example":true
        },
        "allowPartialDispensation":{
            "type":"boolean",
            "description":"Indicate whether partial dispensation is allowed.",
            "example":true
        },
        "confirmDispensation":{
            "title":"Confirm Dispensation",
            "type":"boolean",
            "description":"Indicates whether dispensation confirmation is required.",
            "example":true
        }
    },
    "description":"Supply settings details object."
}

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