Jump to

• Request
• Response

v2.0

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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical depot

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : UpdateDepotKitsRequest v2.0

Type: object

Title: UpdateDepotKitsRequest v2.0

Request to update status of serialized and non-serialized kits.

Show Source

• inventoryStatusId(required): number (BigDecimal)
  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 v2.0
  Title: DepotKitFiltersRequest v2.0

  Request object for kit filters.
• kits: array Kits
  Title: Kits

  Kit ID.
• kitsFilter: object DepotKitFiltersRequest v2.0
  Title: DepotKitFiltersRequest v2.0

  Request object for kit filters.
• partialUpdate: boolean
  Title: Partial Update

  Indicates whether a single non-serialized record is being updated.

  Example: false
• quantity(required): number (BigDecimal)
  Title: Quantity

  Minimum Value: 1

  Kit quantity.

  Example: 15
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason.

  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":"BigDecimal",
            "example":10,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "quantity":{
            "title":"Quantity",
            "minimum":1,
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":15
        },
        "partialUpdate":{
            "title":"Partial Update",
            "type":"boolean",
            "description":"Indicates whether a single non-serialized record is being updated.",
            "example":false
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason.",
            "example":"new kits are available"
        },
        "kitFilters":{
            "$ref":"#/components/schemas/DepotKitFiltersRequestV2"
        },
        "kitsFilter":{
            "$ref":"#/components/schemas/DepotKitFiltersRequestV2"
        }
    },
    "description":"Request to update status of serialized and non-serialized kits."
}

Nested Schema : DepotKitFiltersRequest v2.0

Type: object

Title: DepotKitFiltersRequest v2.0

Request object for kit filters.

Show Source

• blindedLotId: string (uuid)
  Title: Blinded Lot ID

  Blinded lot ID.
• inventoryStatusIds: array Inventory Status IDs
  Title: Inventory Status IDs

  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).
• kitNumberMax: number
  Kit maximum number.

  Example: 1
• kitNumberMin: number
  Kit minimum number.

  Example: 1
• quarantineId: string
  Title: Quarantine ID

  Quarantine ID.

  Example: 0000000000001
• searchByKitNumber: string
  Title: Kit Number

  Kit number.

  Example: KIT001
• searchBySeqNumber: number
  Sequence number.

  Example: 1
• sequenceNumberMax: number
  Kit maximum sequence number.

  Example: 1
• sequenceNumberMin: number
  Kit minimum sequence number.

  Example: 1
• serialized: boolean
  Title: Serialized

  Flag to filter serialized kits.

  Example: true
• shipmentNumber: string
  Title: Shipment Number

  Shipment number.

  Example: Shipment1

{
    "title":"DepotKitFiltersRequest v2.0",
    "type":"object",
    "properties":{
        "searchByKitNumber":{
            "title":"Kit Number",
            "type":"string",
            "description":"Kit number.",
            "example":"KIT001"
        },
        "searchBySeqNumber":{
            "type":"number",
            "description":"Sequence number.",
            "example":1
        },
        "sequenceNumberMin":{
            "type":"number",
            "description":"Kit minimum sequence number.",
            "example":1
        },
        "sequenceNumberMax":{
            "type":"number",
            "description":"Kit maximum sequence number.",
            "example":1
        },
        "kitNumberMin":{
            "type":"number",
            "description":"Kit minimum number.",
            "example":1
        },
        "kitNumberMax":{
            "type":"number",
            "description":"Kit maximum number.",
            "example":1
        },
        "blindedLotId":{
            "title":"Blinded Lot ID",
            "type":"string",
            "description":"Blinded lot ID.",
            "format":"uuid"
        },
        "shipmentNumber":{
            "title":"Shipment Number",
            "type":"string",
            "description":"Shipment number.",
            "example":"Shipment1"
        },
        "quarantineId":{
            "title":"Quarantine ID",
            "type":"string",
            "description":"Quarantine ID.",
            "example":"0000000000001"
        },
        "inventoryStatusIds":{
            "title":"Inventory Status IDs",
            "type":"array",
            "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":[
                5,
                10
            ],
            "items":{
                "type":"integer",
                "format":"int32"
            }
        },
        "serialized":{
            "title":"Serialized",
            "type":"boolean",
            "description":"Flag to filter serialized kits.",
            "example":true
        }
    },
    "description":"Request object for kit filters."
}

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 : Inventory Status IDs

Type: array

Title: Inventory Status IDs

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

Show Source

• Array of: integer(int32)

{
    "title":"Inventory Status IDs",
    "type":"array",
    "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":[
        5,
        10
    ],
    "items":{
        "type":"integer",
        "format":"int32"
    }
}

Example:

[
    5,
    10
]

Examples

Select an example Update Depot Kits Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : UpdateDepotKitsResponse

Type: object

Title: UpdateDepotKitsResponse

Response object of update kit.

Show Source

• tempExcursionNumber: string
  Title: Temperature Excursion Number

  Temperature excursion number.

  Example: 0000000000001
• transactionId: string (uuid)
  Title: Transaction ID

  Transaction identifier of shipments.

{
    "title":"UpdateDepotKitsResponse",
    "type":"object",
    "properties":{
        "tempExcursionNumber":{
            "title":"Temperature Excursion Number",
            "type":"string",
            "description":"Temperature excursion number.",
            "example":"0000000000001"
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"string",
            "description":"Transaction identifier of shipments.",
            "format":"uuid"
        }
    },
    "description":"Response object of update kit."
}

Examples

Select an example Update Depot Kits Response

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

Body ()

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

Examples

Select an example Bad Request

404 Response

Invalid study ID or version

Body ()

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

Examples

Select an example Not Found

500 Response

Internal server error

Body ()

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

Examples

Select an example Server Error

Back to Top