Jump to

• Request
• Response

Get supply settings

get

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

Retrieves supply settings. Rights: SupplySettingRightsGet. Required sponsor roles are: clinical supply manager and site manager. Added new field: confirmDispensation in Response.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of 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 v5.0

Type: object

Title: SupplySettingsTO v5.0

Supply settings details object.

Show Source

• allowBarcodeScan(required): boolean
  Indicate whether barcode scan is allowed.

  Example: true
• allowManualConsignments(required): boolean
  Indicate whether to allow manual consignments.

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

  Example: true
• allowSingleKitQuarantine(required): boolean
  Indicate whether to allow single kit quarantine.

  Example: true
• customShipmentIdPrefix: string
  Custom shipment id prefix when shipment prefix type is CUSTOM.

  Example: SomePrefix
• depotKitReconRequired(required): boolean
  Depot kit reconciliation required.

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

  Example: 2
• intlShipmentVisitId: string (uuid)
  Initial shipment visit Id
• kitReconciliationRequired(required): boolean
  Indicate whether kit reconciliation is required.

  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)
  Default kit type Id
• shipmentPrefixType(required): string
  Allowed Values: [ "DEPOTID", "CUSTOM", "NONE" ]

  Shipment prefix type.

  Example: DEPOTID
• singleKitSettingId: number (double)
  Single kit setting Id.

  Example: 1
• useBlindingGroups(required): boolean
  Indicate whether to use blinding groups.

  Example: true
• useLabelGroups(required): boolean
  Indicate whether to use label groups.

  Example: true
• useShippingGroups(required): boolean
  Indicate whether to use shipping groups.

  Example: true
• useTemperatureExcursion(required): boolean
  Indicate whether to use temperature excursion.

  Example: true
• waitDaysBeforeNotifying: number (double)
  Minimum Value: 0

  Maximum Value: 30

  Number of days after the ship date (or the raise date, if the ship date isn't defined) when a site user receives a notification to mark a shipment as received.

  Example: 2

{
    "title":"SupplySettingsTO v5.0",
    "required":[
        "allowBarcodeScan",
        "allowManualConsignments",
        "allowPartialDispensation",
        "allowSingleKitQuarantine",
        "depotKitReconRequired",
        "intlShipmentTriggerId",
        "kitReconciliationRequired",
        "reuseOnlyLastVisitKkits",
        "reuseSealedKits",
        "shipmentPrefixType",
        "useBlindingGroups",
        "useLabelGroups",
        "useShippingGroups",
        "useTemperatureExcursion"
    ],
    "type":"object",
    "properties":{
        "useBlindingGroups":{
            "type":"boolean",
            "description":"Indicate whether to use blinding groups.",
            "example":true
        },
        "useLabelGroups":{
            "type":"boolean",
            "description":"Indicate whether to use label groups.",
            "example":true
        },
        "useShippingGroups":{
            "type":"boolean",
            "description":"Indicate whether to use shipping groups.",
            "example":true
        },
        "useTemperatureExcursion":{
            "type":"boolean",
            "description":"Indicate whether to use temperature excursion.",
            "example":true
        },
        "allowSingleKitQuarantine":{
            "type":"boolean",
            "description":"Indicate whether to allow single kit quarantine.",
            "example":true
        },
        "allowManualConsignments":{
            "type":"boolean",
            "description":"Indicate whether to allow manual consignments.",
            "example":true
        },
        "singleKitSettingId":{
            "type":"number",
            "description":"Single kit setting Id.",
            "format":"double",
            "example":"1"
        },
        "sendKitTypeForSingleKitOrder":{
            "type":"string",
            "description":"Default kit type Id",
            "format":"uuid"
        },
        "intlShipmentTriggerId":{
            "type":"number",
            "description":"Initial shipment trigger Id.",
            "format":"double",
            "example":"2"
        },
        "intlShipmentVisitId":{
            "type":"string",
            "description":"Initial shipment visit Id",
            "format":"uuid"
        },
        "waitDaysBeforeNotifying":{
            "maximum":"30",
            "minimum":"0",
            "type":"number",
            "description":"Number of days after the ship date (or the raise date, if the ship date isn't defined) when a site user receives a notification to mark a shipment as received.",
            "format":"double",
            "example":"2"
        },
        "shipmentPrefixType":{
            "type":"string",
            "description":"Shipment prefix type.",
            "example":"DEPOTID",
            "enum":[
                "DEPOTID",
                "CUSTOM",
                "NONE"
            ]
        },
        "customShipmentIdPrefix":{
            "type":"string",
            "description":"Custom shipment id prefix when shipment prefix type is CUSTOM.",
            "example":"SomePrefix"
        },
        "kitReconciliationRequired":{
            "type":"boolean",
            "description":"Indicate whether kit reconciliation is required.",
            "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
        },
        "allowBarcodeScan":{
            "type":"boolean",
            "description":"Indicate whether barcode scan is allowed.",
            "example":true
        },
        "depotKitReconRequired":{
            "type":"boolean",
            "description":"Depot kit reconciliation 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