Jump to

• Request
• Response

v3.0

get

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

Retrieves kit summary by kit type ID with new Column : BlockNumbers, kitNumberUTF8. Rights: OrsInventoryGet and OrsUnblinded.

Request

Path Parameters

• kitTypeId(required): string
  ID of the kit type.
• 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.

Query Parameters

• blockNumber: string
  Block number
• kitNumber: string
  Kit number
• kitRange(required): string
  Range of the kit.
• kitStatus(required): string
  Status of the kit.
• labelGroupId(required): string
  ID of the label group.
• limit: string
  Maximum number of records to display per page.
• location(required): string
  Location of the kit.
• lotId(required): string
  ID of the lot.
• offset: string
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.
• sortBy: string
  Specify the parameter by which the kits are ordered. Default value is 'SEQUENCE_NUMBER'.

  Default Value: SEQUENCE_NUMBER

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : KitDetailsResponse

Type: object

Title: KitDetailsResponse

Contains kit detail response.

Show Source

• count: integer (int64)
  Total count of result
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• kits: array kits
• kitTypeId: string
  Title: Kit Type ID

  Kit type identifier.

  Example: B1B8327AFAA6412287106192AB5984EF
• kitTypeName: string
  Title: Kit Type Name

  Kit type name.

  Example: Kit1001
• limit: integer (int64)
  Maximum number of records to display per page.
• links: array links
• maxKitNumber: integer (int32)
  Kit maximum number.

  Example: 5
• maxSequenceNumber: integer (int32)
  Kit maximum sequence number.

  Example: 5
• minKitNumber: integer (int32)
  Kit minimum number.

  Example: 5
• minSequenceNumber: integer (int32)
  Kit minimum sequence number.

  Example: 5
• offset: integer (int64)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.

  Example: 400
• totalResults: integer (int64)
  Total number of entities in response

{
    "title":"KitDetailsResponse",
    "type":"object",
    "properties":{
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitTypeName":{
            "title":"Kit Type Name",
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit1001"
        },
        "minKitNumber":{
            "type":"integer",
            "description":"Kit minimum number.",
            "format":"int32",
            "example":5
        },
        "maxKitNumber":{
            "type":"integer",
            "description":"Kit maximum number.",
            "format":"int32",
            "example":5
        },
        "minSequenceNumber":{
            "type":"integer",
            "description":"Kit minimum sequence number.",
            "format":"int32",
            "example":5
        },
        "maxSequenceNumber":{
            "type":"integer",
            "description":"Kit maximum sequence number.",
            "format":"int32",
            "example":5
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitDetailsTO"
            }
        },
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter.",
            "format":"int64",
            "example":400
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        }
    },
    "description":"Contains kit detail response."
}

Nested Schema : kits

Type: array

Show Source

• Array of: object KitDetailsTO v1.0
  Title: KitDetailsTO v1.0

  Contains kit details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KitDetailsTO"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelLink"
    }
}

Nested Schema : KitDetailsTO v1.0

Type: object

Title: KitDetailsTO v1.0

Contains kit details.

Show Source

• blindedLotId: string
  Title: Blinded Lot ID

  Blinded lot ID.

  Example: 9BD49A59E47E4383B98802712763FD43
• blindedLotNumber: string
  Title: Blinded Lot Number

  Blinded lot number.

  Example: BLot1101
• inventoryId: string (uuid)
  Title: Inventory ID

  Inventory ID.
• inventoryStatus: string
  Title: Inventory Status

  Name of the inventory status.

  Example: Dispensed
• inventoryStatusId: number (BigDecimal)
  Title: Inventory Status ID

  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
• kitNumber: number (BigDecimal)
  Title: Kit Number

  Kit number.

  Example: 10
• labelGroup: string
  Title: Label Group

  Label group.

  Example: Labelgroup1001
• labelGroupId: string
  Title: Label Group ID

  Label group ID.

  Example: 9BD49A59E47E4383B98802712763FD43
• locationId: string
  Title: Location ID

  Location.

  Example: 1873CDF69E9B48B89B2D9E7951057D09
• manufacturingLotId: string
  Title: Manufacturing Lot ID

  Manufacturing lot ID.

  Example: 9BD49A59E47E4383B98802712763FD43
• manufacturingLotNumber: string
  Title: Manufacturing Lot Number

  Manufacturing lot number.

  Example: Mlot1001
• sequenceNumber: number (BigDecimal)
  Title: Sequence Number

  Sequence number.

  Example: 10

{
    "title":"KitDetailsTO v1.0",
    "type":"object",
    "properties":{
        "kitNumber":{
            "title":"Kit Number",
            "type":"number",
            "description":"Kit number.",
            "format":"BigDecimal",
            "example":10
        },
        "sequenceNumber":{
            "title":"Sequence Number",
            "type":"number",
            "description":"Sequence number.",
            "format":"BigDecimal",
            "example":10
        },
        "inventoryStatusId":{
            "title":"Inventory Status ID",
            "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
        },
        "locationId":{
            "title":"Location ID",
            "type":"string",
            "description":"Location.",
            "example":"1873CDF69E9B48B89B2D9E7951057D09"
        },
        "manufacturingLotId":{
            "title":"Manufacturing Lot ID",
            "type":"string",
            "description":"Manufacturing lot ID.",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "blindedLotId":{
            "title":"Blinded Lot ID",
            "type":"string",
            "description":"Blinded lot ID.",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "labelGroupId":{
            "title":"Label Group ID",
            "type":"string",
            "description":"Label group ID.",
            "example":"9BD49A59E47E4383B98802712763FD43"
        },
        "inventoryStatus":{
            "title":"Inventory Status",
            "type":"string",
            "description":"Name of the inventory status.",
            "example":"Dispensed"
        },
        "manufacturingLotNumber":{
            "title":"Manufacturing Lot Number",
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"Mlot1001"
        },
        "blindedLotNumber":{
            "title":"Blinded Lot Number",
            "type":"string",
            "description":"Blinded lot number.",
            "example":"BLot1101"
        },
        "labelGroup":{
            "title":"Label Group",
            "type":"string",
            "description":"Label group.",
            "example":"Labelgroup1001"
        },
        "inventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        }
    },
    "description":"Contains kit details."
}

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

• href: string
  Realtive URL
• rel: string
  link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

400 Response

Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filtersOR Invalid kit type OR Invalid Lot OR Invalid location

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 or Kit type not found

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