Jump to

• Request
• Response

v1.0

put

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

Updates kit status. 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

Request Body - application/json ()

Root Schema : UpdateKitStatusRequest v1.0

Type: object

Title: UpdateKitStatusRequest v1.0

Request to update kit status.

Show Source

• inventoryStatusId(required): integer (int32)
  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
• kitFilters: object KitFiltersRequest v1.0
  Title: KitFiltersRequest v1.0

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

  List of kit IDs.
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason.

  Example: kit damaged by subject

{
    "title":"UpdateKitStatusRequest v1.0",
    "required":[
        "inventoryStatusId"
    ],
    "type":"object",
    "properties":{
        "kitFilters":{
            "$ref":"#/components/schemas/KitFiltersRequestV1"
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"List of kit IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason.",
            "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":5
        }
    },
    "description":"Request to update kit status."
}

Nested Schema : KitFiltersRequest v1.0

Type: object

Title: KitFiltersRequest v1.0

Request object for kit filters.

Show Source

• kitRange: string
  Kit range.

  Example: SEQUENCE_NUMBER:900:1200
• kitStatus: string
  Kit status ID.

  Example: 1
• kitTypeId: string (uuid)
  Title: Kit Type ID

  Kit type identifier.
• labelGroupId: string
  Label group ID.

  Example: B1B8327AFAA6412287106192AB5984EF
• location: string
  Location.

  Example: ALL_SITES
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.

{
    "title":"KitFiltersRequest v1.0",
    "type":"object",
    "properties":{
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "location":{
            "type":"string",
            "description":"Location.",
            "example":"ALL_SITES"
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "kitStatus":{
            "type":"string",
            "description":"Kit status ID.",
            "example":"1"
        },
        "kitRange":{
            "type":"string",
            "description":"Kit range.",
            "example":"SEQUENCE_NUMBER:900:1200"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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

Invalid kit OR Specify at least one filter OR Either kits or kitFilters is required OR Invalid Inventory Status OR All kits should have same inventory status 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

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

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

Back to Top