REST API for Clinical One Platform

v4.0

put

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}

Updates a kit's status at a site by kit ID. If the new status is quarantined it will generate a temperature excursion number.
Rights: OrsInventoryPost and either OrsUnblinded or OrsBlinded.

Request

Path Parameters

kitId(required): string(uuid)

ID of the kit.
mode(required): string

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

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
studyId(required): string(uuid)

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

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

instanceNumber: number (BigDecimal)

InstanceNumber
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

Contains kit IDs.
kitsFilter: object SiteUserUpdateKitsFilter

Contains filter criteria to update kits.
missingUnits: number (BigDecimal)

Missing Units of Kit.
reason: string

Reason description.
returnedUnits: number (BigDecimal)

Returned Units of Kit.
subjectId: string (uuid)

Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
visitSrcId: string (uuid)

Visit source ID

{
    "required":[
        "inventoryStatusId"
    ],
    "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
            ]
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason description."
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned Units of Kit.",
            "format":"BigDecimal"
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing Units of Kit.",
            "format":"BigDecimal"
        },
        "visitSrcId":{
            "type":"string",
            "description":"Visit source ID",
            "format":"uuid"
        },
        "instanceNumber":{
            "type":"number",
            "description":"InstanceNumber",
            "format":"BigDecimal"
        },
        "kits":{
            "title":"kits",
            "type":"array",
            "description":"Contains kit IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/SiteUserUpdateKitsFilter"
        }
    }
}

Nested Schema : kits

Type: array

Title: kits

Contains kit IDs.

Show Source

Array of: string(uuid)

{
    "title":"kits",
    "type":"array",
    "description":"Contains kit IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : SiteUserUpdateKitsFilter

Type: object

Contains filter criteria to update kits.

Show Source

inventoryStatusIds: array inventoryStatusIds

Title: inventoryStatusIds

List of inventory status IDs.
kitRange: string

Range of the kit.
searchString: string

Search string.
serialized: boolean

Is kit serialized or non-serialized

{
    "type":"object",
    "properties":{
        "serialized":{
            "type":"boolean",
            "description":"Is kit serialized or non-serialized"
        },
        "kitRange":{
            "type":"string",
            "description":"Range of the kit."
        },
        "searchString":{
            "type":"string",
            "description":"Search string."
        },
        "inventoryStatusIds":{
            "title":"inventoryStatusIds",
            "type":"array",
            "description":"List of inventory status IDs.",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        }
    },
    "description":"Contains filter criteria to update kits."
}

Nested Schema : inventoryStatusIds

Type: array

Title: inventoryStatusIds

List of inventory status IDs.

Show Source

Array of: integer(int32)

{
    "title":"inventoryStatusIds",
    "type":"array",
    "description":"List of inventory status IDs.",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : IDResponse v1.0

Type: object

Title: IDResponse v1.0

Response containing the identifier.

Show Source

id: string (uuid)

ID

{
    "title":"IDResponse v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID",
            "format":"uuid"
        }
    },
    "description":"Response containing the identifier."
}

400 Response

For invalid subject or inventory status or invalid transition status for, kit does not belong to site.

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

For invalid study ID or study still in design phase AND for invalid kit and study combination.

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