REST API for Clinical One Platform

Update kit attributes from depot inventory by depot ID

put

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits

Updates kit attributes from depot inventory by depot ID, for both serialized and non serialized kits. Rights: OrsInventoryPost and OrsUnblinded.

Request

Path Parameters

depotId(required): string(uuid)

ID of the depot
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 : UpdateDepotKitsRequest v2.0

Type: object

Title: UpdateDepotKitsRequest v2.0

Request object to update status of serialized & non serialized kits

Show Source

inventoryStatusId(required): number (Integer)

Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]

Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

Example: 10
kitFilters: object DepotKitFiltersRequest
kits: array kits

Title: kits

Kit id.
kitsFilter: object kitsFilter

Kit filter request
partialUpdate: boolean

if single record is getting updated

Example: false
quantity(required): number

Minimum Value: 1

Quantity of kits in a lot

Example: 15
reason: string

Minimum Length: 0

Maximum Length: 255

Reason of update

Example: new kits are available

{
    "title":"UpdateDepotKitsRequest v2.0",
    "required":[
        "inventoryStatusId",
        "quantity"
    ],
    "type":"object",
    "properties":{
        "kits":{
            "title":"kits",
            "type":"array",
            "description":"Kit id.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"Integer",
            "example":10,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "quantity":{
            "minimum":1,
            "type":"number",
            "description":"Quantity of kits in a lot",
            "example":15
        },
        "partialUpdate":{
            "type":"boolean",
            "description":"if single record is getting updated",
            "example":false
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason of update",
            "example":"new kits are available"
        },
        "kitFilters":{
            "$ref":"#/components/schemas/DepotKitFiltersRequest"
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/kitsFilter"
        }
    },
    "description":"Request object to update status of serialized & non serialized kits"
}

Nested Schema : DepotKitFiltersRequest

Type: object

Show Source

blindedLotId: string (uuid)

blindedLotId
inventoryStatusIds: array inventoryStatusIds

Title: inventoryStatusIds

inventoryStatusIds
kitNumberMax: number

kitNumberMax

Example: 1
kitNumberMin: number

kitNumberMin

Example: 1
quarantineId: string

quarantineId

Example: 0000000000001
SearchString: number

SearchString

Example: 1
sequenceNumberMax: number

sequenceNumberMax

Example: 1
sequenceNumberMin: number

sequenceNumberMin

Example: 1
serialized: boolean

flag for serialized kits

Example: true
shipmentNumber: string

shipmentNumber

Example: Shipment1

{
    "type":"object",
    "properties":{
        "SearchString":{
            "type":"number",
            "description":"SearchString",
            "example":1
        },
        "sequenceNumberMin":{
            "type":"number",
            "description":"sequenceNumberMin",
            "example":1
        },
        "sequenceNumberMax":{
            "type":"number",
            "description":"sequenceNumberMax",
            "example":1
        },
        "kitNumberMin":{
            "type":"number",
            "description":"kitNumberMin",
            "example":1
        },
        "kitNumberMax":{
            "type":"number",
            "description":"kitNumberMax",
            "example":1
        },
        "blindedLotId":{
            "type":"string",
            "description":"blindedLotId",
            "format":"uuid"
        },
        "shipmentNumber":{
            "type":"string",
            "description":"shipmentNumber",
            "example":"Shipment1"
        },
        "quarantineId":{
            "type":"string",
            "description":"quarantineId",
            "example":"0000000000001"
        },
        "inventoryStatusIds":{
            "title":"inventoryStatusIds",
            "type":"array",
            "description":"inventoryStatusIds",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "serialized":{
            "type":"boolean",
            "description":"flag for serialized kits",
            "example":true
        }
    }
}

Nested Schema : kits

Type: array

Title: kits

Kit id.

Show Source

Array of: string(uuid)

{
    "title":"kits",
    "type":"array",
    "description":"Kit id.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : kitsFilter

Type: object

Kit filter request

Show Source

blindedLotId: string (uuid)

blindedLotId
inventoryStatusIds: array inventoryStatusIds

Title: inventoryStatusIds

inventoryStatusIds
kitNumberMax: number

kitNumberMax

Example: 1
kitNumberMin: number

kitNumberMin

Example: 1
quarantineId: string

quarantineId

Example: 0000000000001
SearchString: number

SearchString

Example: 1
sequenceNumberMax: number

sequenceNumberMax

Example: 1
sequenceNumberMin: number

sequenceNumberMin

Example: 1
serialized: boolean

flag for serialized kits

Example: true
shipmentNumber: string

shipmentNumber

Example: Shipment1

{
    "type":"object",
    "properties":{
        "SearchString":{
            "type":"number",
            "description":"SearchString",
            "example":1
        },
        "sequenceNumberMin":{
            "type":"number",
            "description":"sequenceNumberMin",
            "example":1
        },
        "sequenceNumberMax":{
            "type":"number",
            "description":"sequenceNumberMax",
            "example":1
        },
        "kitNumberMin":{
            "type":"number",
            "description":"kitNumberMin",
            "example":1
        },
        "kitNumberMax":{
            "type":"number",
            "description":"kitNumberMax",
            "example":1
        },
        "blindedLotId":{
            "type":"string",
            "description":"blindedLotId",
            "format":"uuid"
        },
        "shipmentNumber":{
            "type":"string",
            "description":"shipmentNumber",
            "example":"Shipment1"
        },
        "quarantineId":{
            "type":"string",
            "description":"quarantineId",
            "example":"0000000000001"
        },
        "inventoryStatusIds":{
            "title":"inventoryStatusIds",
            "type":"array",
            "description":"inventoryStatusIds",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "serialized":{
            "type":"boolean",
            "description":"flag for serialized kits",
            "example":true
        }
    },
    "description":"Kit filter request"
}

Nested Schema : inventoryStatusIds

Type: array

Title: inventoryStatusIds

inventoryStatusIds

Show Source

Array of: integer(int32)

{
    "title":"inventoryStatusIds",
    "type":"array",
    "description":"inventoryStatusIds",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Nested Schema : inventoryStatusIds

Type: array

Title: inventoryStatusIds

inventoryStatusIds

Show Source

Array of: integer(int32)

{
    "title":"inventoryStatusIds",
    "type":"array",
    "description":"inventoryStatusIds",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : UpdateDepotKitsResponse v1.0

Type: object

Title: UpdateDepotKitsResponse v1.0

Response object of update kit

Show Source

tempExcursionNumber: string

tempExcursionNumber

Example: 0000000000001
transactionId: string (uuid)

transactionId

{
    "title":"UpdateDepotKitsResponse v1.0",
    "type":"object",
    "properties":{
        "tempExcursionNumber":{
            "type":"string",
            "description":"tempExcursionNumber",
            "example":"0000000000001"
        },
        "transactionId":{
            "type":"string",
            "description":"transactionId",
            "format":"uuid"
        }
    },
    "description":"Response object of update kit"
}

400 Response

Specify at least one kit attribute OR Reason is required OR Specify at least one filter. OR Either kits or kitFilters is required OR Invalid kit status OR Invalid kit range filter OR Invalid lot OR Invalid label group in kit filters OR Invalid kit type OR Invalid location OR No kits to update OR Update kits retrieved size exceeds maximum rows for update limit OR Invalid inventory status transition

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 or version

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