Jump to

• Request
• Response

v5.0

get

/ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits

Retrieves a serialized and non-serialized kit's details by order. Rights: OrsInventoryGet, OrsUnblinded. Added new field: nsKits to the response.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• shipmentId(required): string(uuid)
  ID of the shipment.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• kitNumber(required): string
  Kit/Lot number.
• orderBy(required): string
  Specify the parameter by which the kits are ordered.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ShipmentKitsResponse v5.0

Type: object

Title: ShipmentKitsResponse v5.0

Response object containing shipment kits details.

Show Source

• kitTypes: array ShipmentKitsResponse.KitTypes
  Title: ShipmentKitsResponse.KitTypes

  List of kit type summaries.
• shipmentId: string (uuid)
  Shipment ID.

{
    "title":"ShipmentKitsResponse v5.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment ID.",
            "format":"uuid"
        },
        "kitTypes":{
            "title":"ShipmentKitsResponse.KitTypes",
            "type":"array",
            "description":"List of kit type summaries.",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV5"
            }
        }
    },
    "description":"Response object containing shipment kits details."
}

Nested Schema : ShipmentKitsResponse.KitTypes

Type: array

Title: ShipmentKitsResponse.KitTypes

List of kit type summaries.

Show Source

• Array of: object ShipmentKitsResponse.KitTypeSummary v5.0
  Title: ShipmentKitsResponse.KitTypeSummary v5.0

  Kit type summary details object.

{
    "title":"ShipmentKitsResponse.KitTypes",
    "type":"array",
    "description":"List of kit type summaries.",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV5"
    }
}

Nested Schema : ShipmentKitsResponse.KitTypeSummary v5.0

Type: object

Title: ShipmentKitsResponse.KitTypeSummary v5.0

Kit type summary details object.

Show Source

• description: string
  Kit type description.

  Example: Non dosing kit
• id: string (uuid)
  Title: Kit Type ID

  Kit type identifier.
• kits: array Kits
  Title: Kits

  List of serialized kits.
• kitTypeName: string
  Kit type name.

  Example: Kit A
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• nsKits: array Non-Serialized Kits
  Title: Non-Serialized Kits

  List of non-serialized kits.
• packageTypeId: number (BigDecimal)
  Allowed Values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

  Package type ID.

  Example: 5
• packageTypeKey: string
  Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

  Package type key.

  Example: INHALER
• unitsPerKit: number (BigDecimal)
  Number of units per kit.

  Example: 5

{
    "title":"ShipmentKitsResponse.KitTypeSummary v5.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid"
        },
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit A"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Non dosing kit"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Package type ID.",
            "format":"BigDecimal",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10
            ]
        },
        "packageTypeKey":{
            "type":"string",
            "description":"Package type key.",
            "example":"INHALER",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Number of units per kit.",
            "format":"BigDecimal",
            "example":5
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"List of serialized kits.",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitV5"
            }
        },
        "nsKits":{
            "title":"Non-Serialized Kits",
            "type":"array",
            "description":"List of non-serialized kits.",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.NonSerializedKitV5"
            }
        }
    },
    "description":"Kit type summary details object."
}

Nested Schema : Kits

Type: array

Title: Kits

List of serialized kits.

Show Source

• Array of: object ShipmentKitsResponse.Kit v5.0
  Title: ShipmentKitsResponse.Kit v5.0

  Kit details object.

{
    "title":"Kits",
    "type":"array",
    "description":"List of serialized kits.",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.KitV5"
    }
}

Nested Schema : Non-Serialized Kits

Type: array

Title: Non-Serialized Kits

List of non-serialized kits.

Show Source

• Array of: object ShipmentKitsResponse.NonSerialized v5.0
  Title: ShipmentKitsResponse.NonSerialized v5.0

  Kit details object.

{
    "title":"Non-Serialized Kits",
    "type":"array",
    "description":"List of non-serialized kits.",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.NonSerializedKitV5"
    }
}

Nested Schema : ShipmentKitsResponse.Kit v5.0

Type: object

Title: ShipmentKitsResponse.Kit v5.0

Kit details object.

Show Source

• barcode: string
  Barcode.

  Example: Kit A
• depotReturnedUnits: number (BigDecimal)
  Number of units returned to depot.

  Example: 5
• id: string (uuid)
  Kit ID.
• inventoryStatusId: 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
• itemNumber: string
  Item number.

  Example: ItemNumber0000001
• kitNumber: number (BigDecimal)
  Kit number.

  Example: 5
• kitNumberUTF: string
  Kit number with UTF-8 support.

  Example: 12345
• materialId: string
  Material ID.

  Example: MaterialId0000001
• missingUnits: number (BigDecimal)
  Missing units for the kit.

  Example: 5
• returnedUnits: number (BigDecimal)
  Returned units for the kit.

  Example: 5
• sequenceNumber: number (BigDecimal)
  Sequence number.

  Example: 5

{
    "title":"ShipmentKitsResponse.Kit v5.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kit ID.",
            "format":"uuid"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"BigDecimal",
            "example":5
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"BigDecimal",
            "example":5
        },
        "barcode":{
            "type":"string",
            "description":"Barcode.",
            "example":"Kit A"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned units for the kit.",
            "format":"BigDecimal",
            "example":5
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing units for the kit.",
            "format":"BigDecimal",
            "example":5
        },
        "depotReturnedUnits":{
            "type":"number",
            "description":"Number of units returned to depot.",
            "format":"BigDecimal",
            "example":5
        },
        "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
        },
        "materialId":{
            "type":"string",
            "description":"Material ID.",
            "example":"MaterialId0000001"
        },
        "itemNumber":{
            "type":"string",
            "description":"Item number.",
            "example":"ItemNumber0000001"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"12345"
        }
    },
    "description":"Kit details object."
}

Nested Schema : ShipmentKitsResponse.NonSerialized v5.0

Type: object

Title: ShipmentKitsResponse.NonSerialized v5.0

Kit details object.

Show Source

• id: string (uuid)
  Non-serialized kit ID.
• inventoryStatusId: 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
• lotId: string (uuid)
  Non-serialized lot ID.
• lotNumber: string
  Lot assigned to non-serialized kits.

  Example: Lot 1
• quantity: number (BigDecimal)
  Title: Quantity

  Kit quantity.

  Example: 1

{
    "title":"ShipmentKitsResponse.NonSerialized v5.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Non-serialized kit ID.",
            "format":"uuid"
        },
        "lotId":{
            "type":"string",
            "description":"Non-serialized lot ID.",
            "format":"uuid"
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot assigned to non-serialized kits.",
            "example":"Lot 1"
        },
        "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
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":1
        }
    },
    "description":"Kit details object."
}

404 Response

'Invalid study ID', 'Study still in design phase' or 'Invalid shipment ID'

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : DesignerResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top