REST API for Clinical One Platform

Assign Pooling Shipment kits

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits

Assign Pooling Shipment kits in a study's inventory. Rights: OrsInventoryPost and DepotShipmentReceiptPost/OrsBlinded.

Request

Path Parameters

mode(required): string

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

Pooling shipment number.
studyId(required): string(uuid)

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Request object containing pooling shipment details.

Show Source

deliveryNumber: string

Delivery Numbert

Example: 88888
kits(required): array kits

Minimum Number of Items: 1

Maximum Number of Items: 2147483647
shipDate(required): string

Pattern: (\d){2}-[a-zA-Z]{3}-(\d){4}

Shipment Date

Example: 12-May-2023
shipmentNumber: string

Shipment Number

Example: Site1
trackingNumber: string

Tracking Number

Example: 123456

{
    "required":[
        "kits",
        "shipDate"
    ],
    "type":"object",
    "properties":{
        "shipDate":{
            "pattern":"(\\d){2}-[a-zA-Z]{3}-(\\d){4}",
            "type":"string",
            "description":"Shipment Date",
            "example":"12-May-2023"
        },
        "kits":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PoolingKits"
            }
        },
        "trackingNumber":{
            "type":"string",
            "description":"Tracking Number",
            "example":"123456"
        },
        "deliveryNumber":{
            "type":"string",
            "description":"Delivery Numbert",
            "example":"88888"
        },
        "shipmentNumber":{
            "type":"string",
            "description":"Shipment Number",
            "example":"Site1"
        }
    },
    "description":"Request object containing pooling shipment details."
}

Nested Schema : kits

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

Array of: object PoolingKits v1.0

Title: PoolingKits v1.0

Object containing Kit details

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

Nested Schema : PoolingKits v1.0

Type: object

Title: PoolingKits v1.0

Object containing Kit details

Show Source

barcode: string

Barcode of the kit

Example: 61234
blockNumber: string

Block Number of the kit

Example: 5
kitNumber(required): string

Item number

Example: i
manufacturingLotNumber(required): string

manufacturingLotNumber

Example: Lot A
poolingId: string

Pooling Id

Example: PooledKitA
sequenceNumber(required): number (BigDecimal)

Sequence number of the kit

Example: 5

{
    "title":"PoolingKits v1.0",
    "required":[
        "kitNumber",
        "manufacturingLotNumber",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number of the kit",
            "format":"BigDecimal",
            "example":5
        },
        "kitNumber":{
            "type":"string",
            "description":"Item number",
            "example":"i"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode of the kit",
            "example":"61234"
        },
        "blockNumber":{
            "type":"string",
            "description":"Block Number of the kit",
            "example":"5"
        },
        "poolingId":{
            "type":"string",
            "description":"Pooling Id",
            "example":"PooledKitA"
        },
        "manufacturingLotNumber":{
            "type":"string",
            "description":"manufacturingLotNumber",
            "example":"Lot A"
        }
    },
    "description":"Object containing Kit details"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : Pooling Shipment Response v1.0

Type: object

Title: Pooling Shipment Response v1.0

Response object containing pooling shipment details.

Show Source

shipmentId: string (uuid)

Shipment Id.

{
    "title":"Pooling Shipment Response v1.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment Id.",
            "format":"uuid"
        }
    },
    "description":"Response object containing pooling shipment details."
}

400 Response

'Invalid shipment

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

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

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