REST API for Clinical One Platform

v3.0

put

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits

Updates kit attributes. This version supports new filter BlockNumber and list of kit type IDs.
Rights: OrsInventoryPost and OrsUnblinded.

Request

Path Parameters

mode(required): string

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

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

application/json

Root Schema : Update Kit Attributes Request v3.0

Type: object

Title: Update Kit Attributes Request v3.0

Request to update kit attributes.

Show Source

inventoryStatusId: 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
itemNumber: string

Item number.

Example: 30100000200000000000000000000005
kitFilters: object KitFiltersRequest v3.0

Title: KitFiltersRequest v3.0

Request object for kit filters.
kits: array Kits

Title: Kits

List of kit IDs.
labelGroupId: string

Label group ID.

Example: 30100000200000000000000000000005
location: string

Location.

Example: 30100000200000000000000000000005
manufacturingLotId: string

Manufacturing lot ID.

Example: 30100000200000000000000000000005
materialId: string

Material ID.

Example: 30100000200000000000000000000005
reason: string

Minimum Length: 0

Maximum Length: 255

Reason

Example: kit damaged by subject
updateItemNumber: boolean

Whether to update the item number.

Example: true
updateMaterialId: boolean

Whether to update the material ID.

Example: true

{
    "title":"Update Kit Attributes Request v3.0",
    "type":"object",
    "properties":{
        "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
            ]
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "example":"30100000200000000000000000000005"
        },
        "location":{
            "type":"string",
            "description":"Location.",
            "example":"30100000200000000000000000000005"
        },
        "manufacturingLotId":{
            "type":"string",
            "description":"Manufacturing lot ID.",
            "example":"30100000200000000000000000000005"
        },
        "materialId":{
            "type":"string",
            "description":"Material ID.",
            "example":"30100000200000000000000000000005"
        },
        "itemNumber":{
            "type":"string",
            "description":"Item number.",
            "example":"30100000200000000000000000000005"
        },
        "updateMaterialId":{
            "type":"boolean",
            "description":"Whether to update the material ID.",
            "example":true
        },
        "updateItemNumber":{
            "type":"boolean",
            "description":"Whether to update the item number.",
            "example":true
        },
        "kitFilters":{
            "$ref":"#/components/schemas/KitFiltersRequestV3"
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"List of kit IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason",
            "example":"kit damaged by subject"
        }
    },
    "description":"Request to update kit attributes."
}

Nested Schema : KitFiltersRequest v3.0

Type: object

Title: KitFiltersRequest v3.0

Request object for kit filters.

Show Source

blockNumber: string

Title: Block Number

Block number.

Example: 1
kitNumber: string

Kit number.

Example: abc-2
kitRange: string

Kit range

Example: SEQUENCE_NUMBER:900:1200
kitStatus: string

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: 1
kitTypeIds: array kitTypeIds

ID of the kit type.
labelGroupId: string

Label group ID.

Example: B1B8327AFAA6412287106192AB5984EF
location: string

Location.

Example: ALL_SITES
lotId: string

Lot ID.

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"KitFiltersRequest v3.0",
    "type":"object",
    "properties":{
        "location":{
            "type":"string",
            "description":"Location.",
            "example":"ALL_SITES"
        },
        "lotId":{
            "type":"string",
            "description":"Lot ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitStatus":{
            "type":"string",
            "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).",
            "example":"1"
        },
        "kitRange":{
            "type":"string",
            "description":"Kit range",
            "example":"SEQUENCE_NUMBER:900:1200"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitNumber":{
            "type":"string",
            "description":"Kit number.",
            "example":"abc-2"
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"string",
            "description":"Block number.",
            "example":"1"
        },
        "kitTypeIds":{
            "type":"array",
            "description":"ID of the kit type.",
            "example":[
                "3F6567865E694182BEEA2B4F76538F05",
                "461A0B8261454C1EBA56285BB538E7B5",
                "EB2B77004EF74E479B6DDBA56D8B6A51"
            ],
            "items":{
                "type":"string",
                "description":"ID of the kit type.",
                "format":"uuid"
            }
        }
    },
    "description":"Request object for kit filters."
}

Nested Schema : Kits

Type: array

Title: Kits

List of kit IDs.

Show Source

Array of: string(uuid)

{
    "title":"Kits",
    "type":"array",
    "description":"List of kit IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : kitTypeIds

Type: array

ID of the kit type.

Show Source

Array of: string(uuid)

ID of the kit type.

{
    "type":"array",
    "description":"ID of the kit type.",
    "example":[
        "3F6567865E694182BEEA2B4F76538F05",
        "461A0B8261454C1EBA56285BB538E7B5",
        "EB2B77004EF74E479B6DDBA56D8B6A51"
    ],
    "items":{
        "type":"string",
        "description":"ID of the kit type.",
        "format":"uuid"
    }
}

Example:

[
    "3F6567865E694182BEEA2B4F76538F05",
    "461A0B8261454C1EBA56285BB538E7B5",
    "EB2B77004EF74E479B6DDBA56D8B6A51"
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : Update Kits Response v1.0

Type: object

Title: Update Kits Response v1.0

Response object of update kit.

Show Source

noOfRowsUpdated: integer (int32)

Title: Number of Kits Updated

Number of kits updated.

Example: 10

{
    "title":"Update Kits Response v1.0",
    "type":"object",
    "properties":{
        "noOfRowsUpdated":{
            "title":"Number of Kits Updated",
            "type":"integer",
            "description":"Number of kits updated.",
            "format":"int32",
            "example":10
        }
    },
    "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