Jump to

• Request
• Response

Get kit details by order

get

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

Retrieves a kit's details by order. Rights: OrsInventoryGet, OrsUnblinded. Added new field: kitNumberUTF 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)
  ID of the study

Query Parameters

• kitNumber(required): string
  Kit 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 v4.0

Type: object

Title: ShipmentKitsResponse v4.0

Response object containing shipment kits details.

Show Source

• kitTypes: array kitTypes
• shipmentId: string (uuid)
  Shipment Id.

{
    "title":"ShipmentKitsResponse v4.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment Id.",
            "format":"uuid"
        },
        "kitTypes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV4"
            }
        }
    },
    "description":"Response object containing shipment kits details."
}

Nested Schema : kitTypes

Type: array

Show Source

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

  Kit type summary details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV4"
    }
}

Nested Schema : ShipmentKitsResponse.KitTypeSummary v4.0

Type: object

Title: ShipmentKitsResponse.KitTypeSummary v4.0

Kit type summary details object.

Show Source

• description: string
  Kit type description.

  Example: Non dosing kit
• id: string (uuid)
  ID of the kit type.
• kits: array kits
• kitTypeName: string
  Kit type name.

  Example: Kit A
• packageTypeId: number (double)
  Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ]

  Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

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

  Package type key.

  Example: INHALER
• unitsPerKit: number (double)
  Number of units perkit.

  Example: 5

{
    "title":"ShipmentKitsResponse.KitTypeSummary v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of the kit type.",
            "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":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "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 perkit.",
            "format":"double",
            "example":"5"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitV4"
            }
        }
    },
    "description":"Kit type summary details object."
}

Nested Schema : kits

Type: array

Show Source

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

  Kit details object.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ShipmentKitsResponse.KitV4"
    }
}

Nested Schema : ShipmentKitsResponse.Kit v4.0

Type: object

Title: ShipmentKitsResponse.Kit v4.0

Kit details object.

Show Source

• barcode: string
  Barcode

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

  Example: 5
• id: string (uuid)
  Kit Id.
• inventoryStatusId: number (double)
  Inventory statusId

  Example: 5
• itemNumber: string
  Item Number

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

  Example: 5
• kitNumberUTF: string
  Kit number in utf-8

  Example: 12345
• materialId: string
  MaterialId Id

  Example: MaterialId0000001
• missingUnits: number (double)
  Missing units.

  Example: 5
• returnedUnits: number (double)
  Returned units.

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

  Example: 5

{
    "title":"ShipmentKitsResponse.Kit v4.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kit Id.",
            "format":"uuid"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":"5"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":"5"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode",
            "example":"Kit A"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned units.",
            "format":"double",
            "example":"5"
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing units.",
            "format":"double",
            "example":"5"
        },
        "depotReturnedUnits":{
            "type":"number",
            "description":"Number of units returned to depot.",
            "format":"double",
            "example":"5"
        },
        "inventoryStatusId":{
            "type":"number",
            "description":"Inventory statusId",
            "format":"double",
            "example":"5"
        },
        "materialId":{
            "type":"string",
            "description":"MaterialId Id",
            "example":"MaterialId0000001"
        },
        "itemNumber":{
            "type":"string",
            "description":"Item Number",
            "example":"ItemNumber0000001"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number in utf-8",
            "example":"12345"
        }
    },
    "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