REST API for Clinical One Platform

Update kit attributes from depot inventory by depot ID

put

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

Updates kit attributes from depot inventory by depot ID, based on the filters passed in the request. 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 : schema

Type: object

Show Source

inventoryStatusId(required): integer (int32)

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
kits: array kits

Title: kits

Kit id.
kitsFilter: object kitsFilter

Kit filter request
reason: string

Minimum Length: 0

Maximum Length: 255

Reason of update

Example: kit damaged by subject

{
    "required":[
        "inventoryStatusId"
    ],
    "type":"object",
    "properties":{
        "kitsFilter":{
            "$ref":"#/components/schemas/kitsFilter"
        },
        "kits":{
            "title":"kits",
            "type":"array",
            "description":"Kit id.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Reason of update",
            "example":"kit damaged by subject"
        },
        "inventoryStatusId":{
            "type":"integer",
            "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":"int32",
            "example":"10",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        }
    }
}

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"
    }
}

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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

404 Response

Invalid study ID or version

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object