REST API for Clinical One Platform

Create a manual depot shipment in resupply strategy

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupply/depotmanual

Creates a manual depot shipment as part of a study's predictive resupply group. Rights: OrsSupplyManagerPost.

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 : ManualDepotSupplyRequest v1.0

Type: object

Title: ManualDepotSupplyRequest v1.0

Manual depot-to-depot supply request object.

Show Source

jobInstanceId: string

Job instance Id.

Example: 4FEBE3E166454E2687C6FAC306E7C86E
kits: array kits

Minimum Number of Items: 1

Maximum Number of Items: 2147483647
shippedFrom(required): string (uuid)

Source depot ID
shippedTo(required): string (uuid)

Destination depot ID

{
    "title":"ManualDepotSupplyRequest v1.0",
    "required":[
        "shippedFrom",
        "shippedTo"
    ],
    "type":"object",
    "properties":{
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance Id.",
            "example":"4FEBE3E166454E2687C6FAC306E7C86E"
        },
        "kits":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DepotShipmentKitRequest"
            }
        },
        "shippedFrom":{
            "type":"string",
            "description":"Source depot ID",
            "format":"uuid"
        },
        "shippedTo":{
            "type":"string",
            "description":"Destination depot ID",
            "format":"uuid"
        }
    },
    "description":"Manual depot-to-depot supply request object."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

Array of: object DepotShipmentKitRequest

Contains kit details for depot shipment creation.

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DepotShipmentKitRequest"
    }
}

Nested Schema : DepotShipmentKitRequest

Type: object

Contains kit details for depot shipment creation.

Show Source

kitTypeId: string (uuid)

ID of the kit type.
quantity: string

Kit quantity

Example: 2

{
    "type":"object",
    "properties":{
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "quantity":{
            "type":"string",
            "description":"Kit quantity",
            "example":"2"
        }
    },
    "description":"Contains kit details for depot shipment creation."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

404 Response

Not found

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

details: object Object

Title: Object

Object with error details information.
errorCode: string

Error code which is stored in ErrorCode enum. Example : C1-003

Example: C1-003
errorMessage: string

Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.