Jump to

• Request
• Response

v3.0

get

/ec-ors-svc/rest/v3.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)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• 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 Kit Type Summary Response
  Title: Kit Type Summary Response

  Kit type summary response.

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

Nested Schema : Kit Type Summary Response

Type: object

Title: Kit Type Summary Response

Kit type summary response.

Show Source

• kitTypes: array Kit Types
  Title: Kit Types

  Kit type summary.
• maxKitNumber: integer (int32)
  Maximum Kit number

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

  Example: 5
• minKitNumber: integer (int32)
  Minimum Kit number

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

  Example: 5

{
    "title":"Kit Type Summary Response",
    "type":"object",
    "properties":{
        "kitTypes":{
            "title":"Kit Types",
            "type":"array",
            "description":"Kit type summary.",
            "items":{
                "$ref":"#/components/schemas/KitTypeSummaryTO"
            }
        },
        "minSequenceNumber":{
            "type":"integer",
            "description":"Kit minimum sequence number.",
            "format":"int32",
            "example":5
        },
        "maxSequenceNumber":{
            "type":"integer",
            "description":"Kit maximum sequence number.",
            "format":"int32",
            "example":5
        },
        "minKitNumber":{
            "type":"integer",
            "description":"Minimum Kit number",
            "format":"int32",
            "example":5
        },
        "maxKitNumber":{
            "type":"integer",
            "description":"Maximum Kit number",
            "format":"int32",
            "example":5
        }
    },
    "description":"Kit type summary response."
}

Nested Schema : Kit Types

Type: array

Title: Kit Types

Kit type summary.

Show Source

• Array of: object KitTypeSummaryTO v4.0
  Title: KitTypeSummaryTO v4.0

  Contains kit type summary detail.

{
    "title":"Kit Types",
    "type":"array",
    "description":"Kit type summary.",
    "items":{
        "$ref":"#/components/schemas/KitTypeSummaryTO"
    }
}

Nested Schema : KitTypeSummaryTO v4.0

Type: object

Title: KitTypeSummaryTO v4.0

Contains kit type summary detail.

Show Source

• description: string
  Kit type description.

  Example: Some description for kit
• kitsAvailable: number (BigDecimal)
  Kits available.
• kitsConserved: number (BigDecimal)
  Title: Kits Conserved

  Conserved kits.
• kitsDamaged: number (BigDecimal)
  Kit damaged.

  Example: 5
• kitsDamagedBySubject: number (BigDecimal)
  Title: Kits Damaged By Subject

  Kits damaged by the subject.
• kitsDestroyed: number (BigDecimal)
  Title: Kits Destroyed

  Destroyed kits.
• kitsDispensed: number (BigDecimal)
  Kit dispensed.

  Example: 5
• kitsExpired: number (int)
  Kits expired.

  Example: 1
• kitsInTransit: number (int)
  Kits in transit.

  Example: 2
• kitsLostBySubject: number (BigDecimal)
  Title: Kits Lost By Subject

  Kits lost by the subject.
• kitsMisallocated: number (BigDecimal)
  Title: Kits Misallocated

  Misallocated kits.
• kitsMissing: number (BigDecimal)
  Title: Kits Missing

  Missing kits.
• kitsNew: number (BigDecimal)
  Title: Kits New

  New kits.
• kitsNotDispensedToSubject: number (BigDecimal)
  Title: Kits Not Dispensed To Subject

  Kits not dispensed to the subject.
• kitsNotInUse: number (BigDecimal)
  Title: Kits Not In Use

  Kits not in use.
• kitsPendingDestruction: number (int)
  Kits pending destruction.

  Example: 0
• kitsPreQuarantined: number (BigDecimal)
  Title: Kits Pre Quarantined

  Kits in pre-quarantine.
• kitsQuarantined: number (BigDecimal)
  Title: Kits Quarantined

  Kits in quarantine.
• kitsReceivedForDestruction: number (BigDecimal)
  Title: Kits Received For Destruction

  Kits received for destruction.
• kitsRestrictedQuarantined: number (BigDecimal)
  Title: Kits Restricted Quarantined

  Kits in restricted quarantine.
• kitsReturnedToSite: number (int)
  Kits returned to site.

  Example: 1
• kitsTemporarilyUnavailable: number (BigDecimal)
  Title: Kits Temporarily Unavailable

  Kits temporarily unavailable.
• kitTypeId: string (uuid)
  Title: Kit Type ID

  ID of the kit type.
• kitTypeName: string
  Kit type name.

  Example: Kit1001
• kitTypeSrcId: string (uuid)
  Kit type ID.
• packageType: string
  Allowed Values: [ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]

  Package type.

  Example: BLISTERPACK
• packageTypeId: number (BigDecimal)
  Package type ID.

  Example: 10
• totalKitNumbers: number (BigDecimal)
  Total kit number.

  Example: 105
• updatableKitsTotal: number (BigDecimal)
  Title: Updatable Kits Total

  The total number of kits that can be updated.

{
    "title":"KitTypeSummaryTO v4.0",
    "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":"Package type ID.",
            "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":"number",
            "description":"Total kit number.",
            "format":"BigDecimal",
            "example":105
        },
        "kitsDispensed":{
            "type":"number",
            "description":"Kit dispensed.",
            "format":"BigDecimal",
            "example":5
        },
        "kitsDamaged":{
            "type":"number",
            "description":"Kit damaged.",
            "format":"BigDecimal",
            "example":5
        },
        "kitsAvailable":{
            "type":"number",
            "description":"Kits available.",
            "format":"BigDecimal"
        },
        "kitsInTransit":{
            "type":"number",
            "description":"Kits in transit.",
            "format":"int",
            "example":2
        },
        "kitsReturnedToSite":{
            "type":"number",
            "description":"Kits returned to site.",
            "format":"int",
            "example":1
        },
        "kitsPendingDestruction":{
            "type":"number",
            "description":"Kits pending destruction.",
            "format":"int",
            "example":0
        },
        "kitsExpired":{
            "type":"number",
            "description":"Kits expired.",
            "format":"int",
            "example":1
        },
        "kitsMisallocated":{
            "title":"Kits Misallocated",
            "type":"number",
            "description":"Misallocated kits.",
            "format":"BigDecimal"
        },
        "kitsRestrictedQuarantined":{
            "title":"Kits Restricted Quarantined",
            "type":"number",
            "description":"Kits in restricted quarantine.",
            "format":"BigDecimal"
        },
        "kitsQuarantined":{
            "title":"Kits Quarantined",
            "type":"number",
            "description":"Kits in quarantine.",
            "format":"BigDecimal"
        },
        "kitsPreQuarantined":{
            "title":"Kits Pre Quarantined",
            "type":"number",
            "description":"Kits in pre-quarantine.",
            "format":"BigDecimal"
        },
        "kitsDestroyed":{
            "title":"Kits Destroyed",
            "type":"number",
            "description":"Destroyed kits.",
            "format":"BigDecimal"
        },
        "kitsNotInUse":{
            "title":"Kits Not In Use",
            "type":"number",
            "description":"Kits not in use.",
            "format":"BigDecimal"
        },
        "kitsMissing":{
            "title":"Kits Missing",
            "type":"number",
            "description":"Missing kits.",
            "format":"BigDecimal"
        },
        "kitsLostBySubject":{
            "title":"Kits Lost By Subject",
            "type":"number",
            "description":"Kits lost by the subject.",
            "format":"BigDecimal"
        },
        "kitsTemporarilyUnavailable":{
            "title":"Kits Temporarily Unavailable",
            "type":"number",
            "description":"Kits temporarily unavailable.",
            "format":"BigDecimal"
        },
        "kitsDamagedBySubject":{
            "title":"Kits Damaged By Subject",
            "type":"number",
            "description":"Kits damaged by the subject.",
            "format":"BigDecimal"
        },
        "kitsNew":{
            "title":"Kits New",
            "type":"number",
            "description":"New kits.",
            "format":"BigDecimal"
        },
        "kitsNotDispensedToSubject":{
            "title":"Kits Not Dispensed To Subject",
            "type":"number",
            "description":"Kits not dispensed to the subject.",
            "format":"BigDecimal"
        },
        "kitsConserved":{
            "title":"Kits Conserved",
            "type":"number",
            "description":"Conserved kits.",
            "format":"BigDecimal"
        },
        "kitsReceivedForDestruction":{
            "title":"Kits Received For Destruction",
            "type":"number",
            "description":"Kits received for destruction.",
            "format":"BigDecimal"
        },
        "updatableKitsTotal":{
            "title":"Updatable Kits Total",
            "type":"number",
            "description":"The total number of kits that can be updated.",
            "format":"BigDecimal"
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "kitTypeId":{
            "title":"Kit Type ID",
            "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

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