Jump to

• Request
• Response

v1.0

get

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

Deprecated: Retrieves a kit's details by order. Rights: OrsInventoryGet, OrsUnblinded.

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 v1.0

Type: object

Title: ShipmentKitsResponse v1.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.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef

{
    "title":"ShipmentKitsResponse v1.0",
    "type":"object",
    "properties":{
        "shipmentId":{
            "type":"string",
            "description":"Shipment ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "kitTypes":{
            "title":"ShipmentKitsResponse.KitTypes",
            "type":"array",
            "description":"List of kit type summaries.",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitTypeSummaryV1"
            }
        }
    },
    "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 v1.0
  Title: ShipmentKitsResponse.KitTypeSummary v1.0

  Kit type summary details object.

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

Nested Schema : ShipmentKitsResponse.KitTypeSummary v1.0

Type: object

Title: ShipmentKitsResponse.KitTypeSummary v1.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.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• kits: array Kits
  Title: Kits

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

  Example: Kit A
• packageTypeId: number (double)
  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

{
    "title":"ShipmentKitsResponse.KitTypeSummary v1.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"Kit type identifier.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "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":"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"
            ]
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"List of serialized kits.",
            "items":{
                "$ref":"#/components/schemas/ShipmentKitsResponse.KitV1"
            }
        }
    },
    "description":"Kit type summary details object."
}

Nested Schema : Kits

Type: array

Title: Kits

List of serialized kits.

Show Source

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

  Kit details object.

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

Nested Schema : ShipmentKitsResponse.Kit v1.0

Type: object

Title: ShipmentKitsResponse.Kit v1.0

Kit details object.

Show Source

• id: string (uuid)
  Kit ID.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• kitNumber: number (double)
  Kit number.

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

  Example: 5

{
    "title":"ShipmentKitsResponse.Kit v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Kit ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        }
    },
    "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