REST API for Clinical One Platform

~~[Deprecated]: Add additional kits to a received shipment~~

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits

Deprecated: Use latest version instead. Adds additional kits to a received shipment in the system. Rights: OrsSupplyManagerPost and OrsBlinded.

Request

Path Parameters

mode(required): string

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

ID of the shipment.
siteId(required): string

ID of the site
studyId(required): string(uuid)

ID of the study

Supported Media Types

Root Schema : schema

Type: object

Request object containing kits to be added to shipment.

Show Source

kits(required): array kits

Contains kits Ids.
nsKits: array nsKits

Contains kits Ids.
shipmentId: string (uuid)

ID of the shipment.

{
    "required":[
        "kits"
    ],
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "kits":{
            "type":"array",
            "description":"Contains kits Ids.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "nsKits":{
            "type":"array",
            "description":"Contains kits Ids.",
            "items":{
                "$ref":"#/components/schemas/ShipmentAddNonSerializedKitRequest"
            }
        }
    },
    "description":"Request object containing kits to be added to shipment."
}

Nested Schema : kits

Type: array

Contains kits Ids.

Show Source

Array of: string(uuid)

{
    "type":"array",
    "description":"Contains kits Ids.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : nsKits

Type: array

Contains kits Ids.

Show Source

Array of: object ShipmentAddNonSerializedKitRequest

Request object containing non serialized kits to be added to shipment.

{
    "type":"array",
    "description":"Contains kits Ids.",
    "items":{
        "$ref":"#/components/schemas/ShipmentAddNonSerializedKitRequest"
    }
}

Nested Schema : ShipmentAddNonSerializedKitRequest

Type: object

Request object containing non serialized kits to be added to shipment.

Show Source

kitTypeSrcId: string (uuid)

ID OF THE KIT
lotId: string (uuid)

Lot ID
quantity(required): number (BigDecimal)

Minimum Value: 1

Maximum Value: 9999

Quantity of kits

Example: 24

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "lotId":{
            "type":"string",
            "description":"Lot ID",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"ID OF THE KIT",
            "format":"uuid"
        },
        "quantity":{
            "maximum":9999,
            "minimum":1,
            "type":"number",
            "description":"Quantity of kits",
            "format":"BigDecimal",
            "example":24
        }
    },
    "description":"Request object containing non serialized kits to be added to shipment."
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: string(uuid)

400 Response

'Invalid kit, 'Invalid shipment status value'

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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 : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid shipment ID'

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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 : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Title: ErrorResponseData

Error Response Details Information
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

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 : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.