Jump to

• Request
• Response

Get kits or a specific kit for a shipment

get

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

Retrieves either all kits or a specific kit (if kit number is provided) for a shipment. Rights: OrsSupplyManagerGet and OrsBlinded. Added additional support for non-serialized kits.

Request

Path Parameters

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

Query Parameters

• kitNumber(required): string
  Kit/Lot number
• limit: string
  Maximum number of records to display per page.

  Default Value: 100
• offset: string
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

  Default Value: 0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : SiteShipmentKitsTO

Type: object

Show Source

• count: integer (int64)
  Total count of result
• hasMore: boolean
  Attribute describes if result set has more records

  Example: true
• kits: array kits
• limit: integer (int64)
  Maximum number of records to display per page.
• links: array links
• offset: integer (int64)
  An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter

  Example: 400
• shipmentId: string
  ID of the shipment.

  Example: 89EE76326E984B548D594D592E5C7FC2
• totalResults: integer (int64)
  Total number of entities in response

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Total count of result",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Attribute describes if result set has more records",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of entities in response",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records to display per page.",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "description":"An order number to specify with which object you want to start retrieving result. If provided, you also need to specify a value for the limit parameter. Offset is affected by the value of the order parameter",
            "format":"int64",
            "example":"400"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelLink"
            }
        },
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"89EE76326E984B548D594D592E5C7FC2"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SiteKitTO"
            }
        }
    }
}

Nested Schema : kits

Type: array

Show Source

• Array of: object SiteKitTO

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

Nested Schema : links

Type: array

Show Source

• Array of: object RelLink
  Object contains link detail.

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

Nested Schema : SiteKitTO

Type: object

Show Source

• barcode: string
  barcode.

  Example: 1236
• deviceConnection: string
  Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

  Device Connection Type

  Example: CloudtoCloud
• deviceType: string
  Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

  Device Type

  Example: GlucoseMonitor
• id: string
  Inventory Id.

  Example: B1B8327AFAA6412287106192AB5984EF
• inventoryStatusId: integer (int32)
  Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]

  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
• kitDescription: string
  Kit Description

  Example: Kit A desc
• kitNumber: integer (int32)
  Kit/Lot number

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

  Example: 12345ab
• kitTypeSrcId: string
  Kit type Id.

  Example: B1B8327AFAA6412287106192AB5984EF
• lotId: string
  Lot Id of non-serialized kits

  Example: B1B8327AFAA6412287106192AB5984EF
• lotNumber: string
  Lot number of non-serialized kits

  Example: Manufacturing lot 1
• quantity: number
  Non-serialized kit quantity

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

  Package Type

  Example: BOTTLE

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Inventory Id.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitNumber":{
            "type":"integer",
            "description":"Kit/Lot number",
            "format":"int32",
            "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",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        },
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit type Id.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit Description",
            "example":"Kit A desc"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Package Type",
            "example":"BOTTLE",
            "enum":[
                "BLISTERPACK",
                "BOTTLE",
                "DEVICE",
                "SYRINGE",
                "OINTMENT",
                "VIAL",
                "INHALER",
                "INFUSION",
                "BOX",
                "OTHER"
            ]
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"GlucoseMonitor",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Device Connection Type",
            "example":"CloudtoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "barcode":{
            "type":"string",
            "description":"barcode.",
            "example":"1236"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Kit number in utf-8 encoding",
            "example":"12345ab"
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot number of non-serialized kits",
            "example":"Manufacturing lot 1"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id  of non-serialized kits",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "quantity":{
            "type":"number",
            "description":"Non-serialized kit quantity",
            "example":"1"
        }
    }
}

Nested Schema : RelLink

Type: object

Object contains link detail.

Show Source

• href: string
  Realtive URL
• rel: string
  link

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"link"
        },
        "href":{
            "type":"string",
            "description":"Realtive URL"
        }
    },
    "description":"Object contains link detail."
}

404 Response

'Invalid study ID', 'Study still in Draft (design phase)', 'Invalid site ID', 'Invalid shipment ID'

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