REST API for Clinical One Platform

Update supply settings

put

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

Updates a study's supply settings by study ID. Rights: SupplySettingRightsPost. Required sponsor roles are: clinical supply manager and site manager. Added new fields: selectShippingAddress.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

Supported Media Types

application/json

Root Schema : SupplySettingsTO v10.0

Type: object

Title: SupplySettingsTO v10.0

Supply settings details object.

Show Source

allKitsSelectedForRandomization(required): boolean

allKitsSelectedForRandomization

Example: false
allowBarcodeScan(required): boolean

Indicate whether barcode scan is allowed.

Example: true
allowDoseHold(required): boolean

AllowDoseHold

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
dispenseByLowestKitNumber(required): boolean

DispenseByLowestKitNumber

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
kitsSelectedForRandomization: array kitsSelectedForRandomization

kitsSelectedForRandomization.
quarantineWithoutTempMonitor(required): boolean

quarantineWithoutTempMonitor

Example: false
randomizeWhenKitsAvailable(required): boolean

randomizeWhenKitsAvailable

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
selectShippingAddress: boolean

selectShippingAddress

Example: false
sendKitTypeForSingleKitOrder: string (uuid)

Default kit type Id
sendNotificationOnce: boolean

sendNotificationOnce

Example: false
shipmentPrefixType(required): string

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

Shipment prefix type.

Example: DEPOTID
singleKitSettingId: number (double)

Single kit setting Id.

Example: 1
tempExcursionStartingNumber: string

tempExcursionStartingNumber.

Example: 12,13
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 v10.0",
    "required":[
        "allKitsSelectedForRandomization",
        "allowBarcodeScan",
        "allowDoseHold",
        "allowManualConsignments",
        "allowPartialDispensation",
        "allowSingleKitQuarantine",
        "depotKitReconRequired",
        "dispenseByLowestKitNumber",
        "intlShipmentTriggerId",
        "kitReconciliationRequired",
        "quarantineWithoutTempMonitor",
        "randomizeWhenKitsAvailable",
        "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
        },
        "dispenseByLowestKitNumber":{
            "type":"boolean",
            "description":"DispenseByLowestKitNumber",
            "example":true
        },
        "allowDoseHold":{
            "type":"boolean",
            "description":"AllowDoseHold",
            "example":true
        },
        "quarantineWithoutTempMonitor":{
            "type":"boolean",
            "description":"quarantineWithoutTempMonitor",
            "example":false
        },
        "randomizeWhenKitsAvailable":{
            "type":"boolean",
            "description":"randomizeWhenKitsAvailable",
            "example":false
        },
        "allKitsSelectedForRandomization":{
            "type":"boolean",
            "description":"allKitsSelectedForRandomization",
            "example":false
        },
        "kitsSelectedForRandomization":{
            "type":"array",
            "description":"kitsSelectedForRandomization.",
            "example":[
                "30100000600000000000000000000000",
                "40100000600000000000000000000000"
            ],
            "items":{
                "type":"string",
                "description":"kitsSelectedForRandomization.",
                "format":"uuid"
            }
        },
        "sendNotificationOnce":{
            "type":"boolean",
            "description":"sendNotificationOnce",
            "example":false
        },
        "tempExcursionStartingNumber":{
            "type":"string",
            "description":"tempExcursionStartingNumber.",
            "example":"12,13"
        },
        "selectShippingAddress":{
            "type":"boolean",
            "description":"selectShippingAddress",
            "example":false
        }
    },
    "description":"Supply settings details object."
}

Nested Schema : kitsSelectedForRandomization

Type: array

kitsSelectedForRandomization.

Show Source

Array of: string(uuid)

kitsSelectedForRandomization.

{
    "type":"array",
    "description":"kitsSelectedForRandomization.",
    "example":[
        "30100000600000000000000000000000",
        "40100000600000000000000000000000"
    ],
    "items":{
        "type":"string",
        "description":"kitsSelectedForRandomization.",
        "format":"uuid"
    }
}

Example:

[
    "30100000600000000000000000000000",
    "40100000600000000000000000000000"
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : IDResponse

Type: object

Response object containing Id.

Show Source

id: string (uuid)

Id

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id",
            "format":"uuid"
        }
    },
    "description":"Response object containing Id."
}

400 Response

Invalid Kit Types OR Invalid selection of Randomize only when all kits are available

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

404 Response

Not found

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object