Jump to

• Request
• Response

v10.0

put

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

Updates a study's supply settings by study ID. This version includes new field selectShippingAddress.
Required sponsor roles are: clinical supply manager and site manager.
Rights: SupplySettingRightsPost.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• allKitsSelectedForRandomization(required): boolean
  Title: All Kits Selected For Randomization

  If true, all kits are selected for randomization.

  Example: false
• allowDoseHold(required): boolean
  Title: Allow Dose Hold

  Indicates whether dose hold is allowed.

  Example: true
• 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
• depotKitReconRequired(required): boolean
  Title: Depot Kit Reconciliation Required

  Depot kit reconciliation required.

  Example: true
• dispenseByLowestKitNumber(required): boolean
  Title: Dispense By Lowest Kit Number

  If true, dispense kits by the lowest available kit number.

  Example: true
• 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
• kitsSelectedForRandomization: array Kits Selected For Randomization
  Title: Kits Selected For Randomization

  Specific kits selected for randomization.
• quarantineWithoutTempMonitor(required): boolean
  Title: Quarantine Without Temperature Monitor

  Indicates whether quarantine is allowed without a temperature monitor.

  Example: false
• randomizeWhenKitsAvailable(required): boolean
  Title: Randomize Only When All Kits Are Available At Site

  If true, subject randomization is allowed only when all required kits are available at the site.

  Example: false
• 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.
• sendNotificationOnce: boolean
  Title: Send Notification Once

  Indicates whether notifications are sent only once.

  Example: false
• 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
• tempExcursionStartingNumber: string
  Title: Temperature Excursion Starting Number

  Starting number for temperature excursions.

  Example: 12,13
• 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

{
    "required":[
        "allKitsSelectedForRandomization",
        "allowDoseHold",
        "allowManualConsignments",
        "allowPartialDispensation",
        "allowSingleKitQuarantine",
        "confirmDispensation",
        "depotKitReconRequired",
        "dispenseByLowestKitNumber",
        "intlShipmentTriggerId",
        "kitReconciliationRequired",
        "quarantineWithoutTempMonitor",
        "randomizeWhenKitsAvailable",
        "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
        },
        "depotKitReconRequired":{
            "title":"Depot Kit Reconciliation Required",
            "type":"boolean",
            "description":"Depot kit reconciliation required.",
            "example":true
        },
        "dispenseByLowestKitNumber":{
            "title":"Dispense By Lowest Kit Number",
            "type":"boolean",
            "description":"If true, dispense kits by the lowest available kit number.",
            "example":true
        },
        "allowDoseHold":{
            "title":"Allow Dose Hold",
            "type":"boolean",
            "description":"Indicates whether dose hold is allowed.",
            "example":true
        },
        "quarantineWithoutTempMonitor":{
            "title":"Quarantine Without Temperature Monitor",
            "type":"boolean",
            "description":"Indicates whether quarantine is allowed without a temperature monitor.",
            "example":false
        },
        "randomizeWhenKitsAvailable":{
            "title":"Randomize Only When All Kits Are Available At Site",
            "type":"boolean",
            "description":"If true, subject randomization is allowed only when all required kits are available at the site.",
            "example":false
        },
        "allKitsSelectedForRandomization":{
            "title":"All Kits Selected For Randomization",
            "type":"boolean",
            "description":"If true, all kits are selected for randomization.",
            "example":false
        },
        "kitsSelectedForRandomization":{
            "title":"Kits Selected For Randomization",
            "type":"array",
            "description":"Specific kits selected for randomization.",
            "items":{
                "title":"Kits Selected For Randomization",
                "type":"string",
                "description":"Specific kits selected for randomization.",
                "format":"uuid"
            }
        },
        "sendNotificationOnce":{
            "title":"Send Notification Once",
            "type":"boolean",
            "description":"Indicates whether notifications are sent only once.",
            "example":false
        },
        "tempExcursionStartingNumber":{
            "title":"Temperature Excursion Starting Number",
            "type":"string",
            "description":"Starting number for temperature excursions.",
            "example":"12,13"
        }
    }
}

Nested Schema : Kits Selected For Randomization

Type: array

Title: Kits Selected For Randomization

Specific kits selected for randomization.

Show Source

• Array of: string(uuid)
  Title: Kits Selected For Randomization

  Specific kits selected for randomization.

{
    "title":"Kits Selected For Randomization",
    "type":"array",
    "description":"Specific kits selected for randomization.",
    "items":{
        "title":"Kits Selected For Randomization",
        "type":"string",
        "description":"Specific kits selected for randomization.",
        "format":"uuid"
    }
}

Examples

Select an example Update Supply Settings Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

• id: string (uuid)
  ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

Examples

Select an example Update Supply Settings Response

400 Response

Invalid shipment OR Invalid Kit status OR One or more shipment are not in valid status OR Custom shipment prefix should be of length between 1 to 10 and contains only alphanumerics OR Invalid shipment prefix type.

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

Examples

Select an example Bad Request

404 Response

Not found

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

Examples

Select an example Not Found

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

Examples

Select an example Server Error

Back to Top