REST API for Clinical One Platform

Mark kits as received

post

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received

Marks kits as received 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
shipmentId(required): string(uuid)

ID of the shipment.
studyId(required): string(uuid)

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

tempMonitorStatus: string

Allowed Values: [ "yes", "no", "missing" ]

Pattern: yes|no|missing

Temprature Montior Status

Example: yes
updateKits: object updateKits

Additional Properties Allowed: additionalProperties
updateNSKits: array updateNSKits

{
    "type":"object",
    "properties":{
        "updateKits":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int32"
            }
        },
        "updateNSKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NSKitsRequest"
            }
        },
        "tempMonitorStatus":{
            "pattern":"yes|no|missing",
            "type":"string",
            "description":"Temprature Montior Status",
            "example":"yes",
            "enum":[
                "yes",
                "no",
                "missing"
            ]
        }
    }
}

Nested Schema : updateKits

Type: object

Additional Properties Allowed

Show Source

integer(int32)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : updateNSKits

Type: array

Show Source

Array of: object NSKitsRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NSKitsRequest"
    }
}

Nested Schema : NSKitsRequest

Type: object

Show Source

inventoryStatusId: number
kitTypeId: string (uuid)
lotId: string (uuid)
quantity(required): number

Minimum Value: 1

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "lotId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "inventoryStatusId":{
            "type":"number"
        },
        "quantity":{
            "minimum":1,
            "type":"number"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ShipmentReceivedResponse

Type: object

Received shipment details response object.

Show Source

availableCount: integer (int64)

Available kits count.

Example: 5
damagedCount: integer (int64)

Damaged kits count.

Example: 5
missingCount: integer (int64)

Missing kits count.

Example: 5
preQuarantinedCount: integer (int64)

Pre quarantined kits count.

Example: 5
receivedDate: string (date-time)

Shipment received date.
shipmentId: string (uuid)

ID of the shipment.

{
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "format":"uuid"
        },
        "receivedDate":{
            "type":"string",
            "description":"Shipment received date.",
            "format":"date-time"
        },
        "damagedCount":{
            "type":"integer",
            "description":"Damaged kits count.",
            "format":"int64",
            "example":5
        },
        "missingCount":{
            "type":"integer",
            "description":"Missing kits count.",
            "format":"int64",
            "example":5
        },
        "preQuarantinedCount":{
            "type":"integer",
            "description":"Pre quarantined kits count.",
            "format":"int64",
            "example":5
        },
        "availableCount":{
            "type":"integer",
            "description":"Available kits count.",
            "format":"int64",
            "example":5
        }
    },
    "description":"Received shipment details response object."
}

400 Response

'Invalid order status', 'Invalid kit'

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