REST API for Clinical One Platform

Update kit status by kit ID

put

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

Updates a kit's status at a site. The formInstanceId is added in response when kits are updated to pending destruction.
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)

ID of the site
studyId(required): string(uuid)

ID of 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 id.
kitsFilter: object SiteUserUpdateKitsFilter

Contains Update kits filter
missingUnits: number (BigDecimal)

Missing Units of Kit
reason: string

Reason
returnedUnits: number (BigDecimal)

Returned Units of Kit
subjectId: string (uuid)

ID of the subject
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":"ID  of the subject",
            "format":"uuid"
        },
        "reason":{
            "type":"string",
            "description":"Reason"
        },
        "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 id.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/SiteUserUpdateKitsFilter"
        }
    }
}

Nested Schema : kits

Type: array

Title: kits

Contains kit id.

Show Source

Array of: string(uuid)

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

Nested Schema : SiteUserUpdateKitsFilter

Type: object

Contains Update kits filter

Show Source

inventoryStatusIds: array inventoryStatusIds

Title: inventoryStatusIds

Contains inventory status id.
kitRange: string

Kit range
searchString: string

Search string
serialized: boolean

{
    "type":"object",
    "properties":{
        "serialized":{
            "type":"boolean"
        },
        "kitRange":{
            "type":"string",
            "description":"Kit range"
        },
        "searchString":{
            "type":"string",
            "description":"Search string"
        },
        "inventoryStatusIds":{
            "title":"inventoryStatusIds",
            "type":"array",
            "description":"Contains inventory status id.",
            "items":{
                "type":"integer",
                "format":"int32"
            }
        }
    },
    "description":"Contains Update kits filter"
}

Nested Schema : inventoryStatusIds

Type: array

Title: inventoryStatusIds

Contains inventory status id.

Show Source

Array of: integer(int32)

{
    "title":"inventoryStatusIds",
    "type":"array",
    "description":"Contains inventory status id.",
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : UpdateSiteKitsResponse v4.0

Type: object

Title: UpdateSiteKitsResponse v4.0

Response object of update kit at site

Show Source

formInstanceId: string (uuid)

formInstanceId
id: string (UUID)

StudyID

Example: 0A2979A33A3C429E99A9441283AFE55E
tempExcursionNumber: string

Temperature excursion number

Example: 001

{
    "title":"UpdateSiteKitsResponse v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"StudyID",
            "format":"UUID",
            "example":"0A2979A33A3C429E99A9441283AFE55E"
        },
        "tempExcursionNumber":{
            "type":"string",
            "description":"Temperature excursion number",
            "example":"001"
        },
        "formInstanceId":{
            "type":"string",
            "description":"formInstanceId",
            "format":"uuid"
        }
    },
    "description":"Response object of update kit at site"
}

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