Jump to

• Request
• Response

v4.0

get

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kitDetails

Retrieves kit details by kit number. In this API, blockNumber and kitNumberUTF are added to return Block Number and Kit Number in UTF8. Rights: OrsInventoryGet 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.

Query Parameters

• kitNumber(required): string
  Kit 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 : Kit Info Response

Type: object

Title: Kit Info Response

Response containing kit details.

Show Source

• kitDetails: object KitDetailsTO v1.0
  Title: KitDetailsTO v1.0

  Contains kit details.

{
    "title":"Kit Info Response",
    "type":"object",
    "properties":{
        "kitDetails":{
            "$ref":"#/components/schemas/KitDetailsTO"
        }
    },
    "description":"Response containing kit details."
}

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."
}

400 Response

Invalid kit number

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

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