Jump to

• Request
• Response

Get kit summary

get

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

Retrieves a kit's summary. Rights: OrsInventoryGet and OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study

Query Parameters

• kitNumber(required): string
  Kit number
• kitRange(required): string
  Range of the kit
• kitStatus(required): string
  Status of the kit
• kitTypeId(required): string
  ID of the kit type.
• labelGroupId(required): string
  ID of the label group
• location(required): string
  Location of the kit
• lotId(required): string
  ID of the lot

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object KitTypeSummaryResponseV3
  Title: KitTypeSummaryResponseV3

  Contains kit type summary response.

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

Nested Schema : KitTypeSummaryResponseV3

Type: object

Title: KitTypeSummaryResponseV3

Contains kit type summary response.

Show Source

• kitTypes: array kitTypes
  Title: kitTypes

  Contains kit type summary.

{
    "title":"KitTypeSummaryResponseV3",
    "type":"object",
    "properties":{
        "kitTypes":{
            "title":"kitTypes",
            "type":"array",
            "description":"Contains kit type summary.",
            "items":{
                "$ref":"#/components/schemas/KitTypeSummaryTO"
            }
        }
    },
    "description":"Contains kit type summary response."
}

Nested Schema : kitTypes

Type: array

Title: kitTypes

Contains kit type summary.

Show Source

• Array of: object KitTypeSummaryTOV3
  Title: KitTypeSummaryTOV3

  Contains kit type summary detail.

{
    "title":"kitTypes",
    "type":"array",
    "description":"Contains kit type summary.",
    "items":{
        "$ref":"#/components/schemas/KitTypeSummaryTO"
    }
}

Nested Schema : KitTypeSummaryTOV3

Type: object

Title: KitTypeSummaryTOV3

Contains kit type summary detail.

Show Source

• description: string
  Kit type description.

  Example: Some description for kit
• kitsAvailable: integer (int32)
  Kits available
• kitsDamaged: integer (int32)
  Kit damaged

  Example: 5
• kitsDispensed: integer (int32)
  Kit dispensed

  Example: 5
• kitsExpired: integer (int32)
  Kits Expired
• kitsInTransit: integer (int32)
  Kits In Transit
• kitsPendingDestruction: integer (int32)
  Kits Pending Destruction
• kitsReturnedToSite: integer (int32)
  Kits Returned to Site
• kitTypeId: string (uuid)
  ID of the kit type.
• kitTypeName: string
  Kit type name.

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

  Package type

  Example: BLISTERPACK
• packageTypeId: number (BigDecimal)
  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: 10
• totalKitNumbers: integer (int32)
  Total kit number

  Example: 105

{
    "title":"KitTypeSummaryTOV3",
    "type":"object",
    "properties":{
        "kitTypeName":{
            "type":"string",
            "description":"Kit type name.",
            "example":"Kit1001"
        },
        "description":{
            "type":"string",
            "description":"Kit type description.",
            "example":"Some description for 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":"BigDecimal",
            "example":"10"
        },
        "packageType":{
            "type":"string",
            "description":"Package type",
            "example":"BLISTERPACK",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "totalKitNumbers":{
            "type":"integer",
            "description":"Total kit number",
            "format":"int32",
            "example":"105"
        },
        "kitsDispensed":{
            "type":"integer",
            "description":"Kit dispensed",
            "format":"int32",
            "example":"5"
        },
        "kitsDamaged":{
            "type":"integer",
            "description":"Kit damaged",
            "format":"int32",
            "example":"5"
        },
        "kitsAvailable":{
            "type":"integer",
            "description":"Kits available",
            "format":"int32"
        },
        "kitsInTransit":{
            "type":"integer",
            "description":"Kits In Transit",
            "format":"int32"
        },
        "kitsReturnedToSite":{
            "type":"integer",
            "description":"Kits Returned to Site",
            "format":"int32"
        },
        "kitsPendingDestruction":{
            "type":"integer",
            "description":"Kits Pending Destruction",
            "format":"int32"
        },
        "kitsExpired":{
            "type":"integer",
            "description":"Kits Expired",
            "format":"int32"
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        }
    },
    "description":"Contains kit type summary detail."
}

400 Response

Invalid kit status OR Invalid kit range filter OR Invalid label group in kit filters OR Invalid kit type OR Invalid Lot OR Invalid location or Invalid kitNumber

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