REST API for Clinical One Platform

Create a manual depot shipment.

post

/ec-ors-svc/rest/v2.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 : schema

Type: object

Contains lot details for depot shipment creation.

Show Source

kitTypeId: string (uuid)

ID of the kit type.
lotId: string (uuid)

ID of the lot.
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"
        },
        "lotId":{
            "type":"string",
            "description":"ID of the lot.",
            "format":"uuid"
        }
    },
    "description":"Contains lot details for depot shipment creation."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: string(uuid)

404 Response

Not found

Root 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 : details

Type: object

500 Response

Internal server error

Root 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 : details

Type: object