Jump to

• Request
• Response

v8.0

get

/ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/orders

Deprecated: Retrieves details of the orders. In this version, non-serialized inventory details are added in the orders. If a kit list is disabled, the shipment will be excluded from the Orders API. Rights: OrsInventoryGet, 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

• endDate(required): string
  The ending date and time (optional). If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, or dd-MMM-yyyy HH:mm.
• includeDepotShipments(required): boolean
  By Default this value is set to False, which the default API will exclude depot to depot shipments.

  Default Value: false
• includePooledShipments(required): boolean
  By Default this value is set to False, which the default API will exclude pooled shipments.

  Default Value: false
• includeReconShipments(required): boolean
  By Default this value is set to False, which the default API will exclude destruction shipments.

  Default Value: false
• limit: integer(int32)
  Minimum Value: 1
• offset: integer(int32)
  Minimum Value: 0
• startDate(required): string
  The starting date and time (optional). If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, or dd-MMM-yyyy HH:mm.
• status: string
  Status of the order.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : OrderInventoryPagedListResponse v8.0

Type: object

Title: OrderInventoryPagedListResponse v8.0

Contains order details for the inventory.

Show Source

• count: integer (int32)
  Number of results in the current page.

  Example: 25
• hasMore: boolean
  Indicates if there are more results beyond the current page.

  Example: true
• limit: integer (int32)
  Maximum number of records returned per page.

  Example: 25
• offset: integer (int32)
  Index of the first record returned in the current page.

  Example: 0
• resultData: array resultData
  Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.
• shipments: array Shipments
  Title: Shipments

  List of orders for shipments.
• totalResults: integer (int32)
  Total number of results across all pages.

  Example: 125

{
    "title":"OrderInventoryPagedListResponse v8.0",
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more results beyond the current page.",
            "example":true
        },
        "totalResults":{
            "type":"integer",
            "description":"Total number of results across all pages.",
            "format":"int32",
            "example":125
        },
        "count":{
            "type":"integer",
            "description":"Number of results in the current page.",
            "format":"int32",
            "example":25
        },
        "limit":{
            "type":"integer",
            "description":"Maximum number of records returned per page.",
            "format":"int32",
            "example":25
        },
        "offset":{
            "type":"integer",
            "description":"Index of the first record returned in the current page.",
            "format":"int32",
            "example":0
        },
        "resultData":{
            "type":"array",
            "description":"Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.",
            "items":{
                "$ref":"#/components/schemas/OrdersInventoryDTOV8"
            }
        },
        "shipments":{
            "title":"Shipments",
            "type":"array",
            "description":"List of orders for shipments.",
            "items":{
                "$ref":"#/components/schemas/OrdersInventoryDTOV8"
            }
        }
    },
    "description":"Contains order details for the inventory."
}

Nested Schema : resultData

Type: array

Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.

Show Source

• Array of: object OrderInventoryDTO v8.0
  Title: OrderInventoryDTO v8.0

  Contains inventory order details.

{
    "type":"array",
    "description":"Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.",
    "items":{
        "$ref":"#/components/schemas/OrdersInventoryDTOV8"
    }
}

Nested Schema : Shipments

Type: array

Title: Shipments

List of orders for shipments.

Show Source

• Array of: object OrderInventoryDTO v8.0
  Title: OrderInventoryDTO v8.0

  Contains inventory order details.

{
    "title":"Shipments",
    "type":"array",
    "description":"List of orders for shipments.",
    "items":{
        "$ref":"#/components/schemas/OrdersInventoryDTOV8"
    }
}

Nested Schema : OrderInventoryDTO v8.0

Type: object

Title: OrderInventoryDTO v8.0

Contains inventory order details.

Show Source

• inventory: array Inventory
  Title: Inventory

  List of inventory records.
• kitTypes: array Kit Types
  Title: Kit Types

  List of kit types for the order.
• nsInventory: array Non-Serialized Inventory
  Title: Non-Serialized Inventory

  List of non-serialized inventory records.
• order: object OrderDTO v5.0
  Title: OrderDTO v5.0

  Contains order related details.
• version: integer (int32)
  Version.

  Example: 1

{
    "title":"OrderInventoryDTO v8.0",
    "type":"object",
    "properties":{
        "order":{
            "$ref":"#/components/schemas/OrderDTOV5"
        },
        "inventory":{
            "title":"Inventory",
            "type":"array",
            "description":"List of inventory records.",
            "items":{
                "$ref":"#/components/schemas/InventoryDTOV3"
            }
        },
        "kitTypes":{
            "title":"Kit Types",
            "type":"array",
            "description":"List of kit types for the order.",
            "items":{
                "$ref":"#/components/schemas/OrdersKitTypes"
            }
        },
        "nsInventory":{
            "title":"Non-Serialized Inventory",
            "type":"array",
            "description":"List of non-serialized inventory records.",
            "items":{
                "$ref":"#/components/schemas/NsInventoryDTO"
            }
        },
        "version":{
            "type":"integer",
            "description":"Version.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Contains inventory order details."
}

Nested Schema : Inventory

Type: array

Title: Inventory

List of inventory records.

Show Source

• Array of: object InventoryDTO v3.0
  Title: InventoryDTO v3.0

  Contains details of inventories.

{
    "title":"Inventory",
    "type":"array",
    "description":"List of inventory records.",
    "items":{
        "$ref":"#/components/schemas/InventoryDTOV3"
    }
}

Nested Schema : Kit Types

Type: array

Title: Kit Types

List of kit types for the order.

Show Source

• Array of: object OrdersKitTypes
  Orders Kit Types object for Pooling Supplies.

{
    "title":"Kit Types",
    "type":"array",
    "description":"List of kit types for the order.",
    "items":{
        "$ref":"#/components/schemas/OrdersKitTypes"
    }
}

Nested Schema : Non-Serialized Inventory

Type: array

Title: Non-Serialized Inventory

List of non-serialized inventory records.

Show Source

• Array of: object NsInventoryDTO v1.0
  Title: NsInventoryDTO v1.0

  Contains non-serialized kit details.

{
    "title":"Non-Serialized Inventory",
    "type":"array",
    "description":"List of non-serialized inventory records.",
    "items":{
        "$ref":"#/components/schemas/NsInventoryDTO"
    }
}

Nested Schema : OrderDTO v5.0

Type: object

Title: OrderDTO v5.0

Contains order related details.

Show Source

• comment: string
  Comment.

  Example: Updated with new values
• deliveryNumber: string
  Title: Delivery Number

  Delivery number.

  Example: Order123
• depotId: string (uuid)
  Depot ID.
• depotVersionStart: string (date-time)
  Depot version start.
• includePooledShipments: boolean
  Title: Include Pooled Shipments

  Indicates whether to include pooled shipments.

  Example: true
• isDepotShipment: boolean
  Depot shipment indicator.

  Example: true
• isReconciliation: boolean
  Indicates whether kit reconciliation is included.

  Example: true
• jobInstanceId: string (uuid)
  Job instance ID.
• objectVersionNumber: number (BigDecimal)
  Object version number.

  Example: 5
• operationType: string
  Allowed Values: [ "CREATED", "MODIFIED", "REMOVED" ]

  Operation type.

  Example: CREATED
• orderDate: string (date-time)
  Order date.
• orderId: string (uuid)
  Order ID.
• orderStatusId: number (double)
  Order status ID.

  Example: 5
• orderType: string
  Allowed Values: [ "INITIAL", "RESUPPLY", "MANUAL" ]

  Order type (Manual or Resupply).

  Example: MANUAL
• orderTypeId: integer (int64)
  Order type ID.

  Example: 5
• reason: string
  Reason.

  Example: DATA ENTRY ERROR
• reportId: string (uuid)
  Report ID.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• shipDate: string (date-time)
  Ship date.
• shipmentId: string
  ID of the shipment.

  Example: 123
• shipmentReceiptDate: string (date-time)
  Title: Shipment Receipt Date

  Shipment receipt date.
• shipmentReceivedById: string (uuid)
  Title: Shipment Received By ID

  Shipment received by ID.
• shippingAddress: string
  Title: Shipping Address

  Shipping address.

  Example: City,Country,Local Address
• shippingAddressId: string (uuid)
  Title: Shipping Address ID

  Shipping address ID.
• siteId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• siteVersionStart: string (date-time)
  Site version start date.
• softwareVersionNumber: number (BigDecimal)
  Software version number.

  Example: 5
• studyId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
• studyVersionStart: string (date-time)
  Study version start.
• trackingNumber: string
  Shipment tracking number.

  Example: 12345
• trackingNumberUrl: string
  Tracking URL.

  Example: http://www.site.com
• userId: string (uuid)
  User ID.

  Example: b1b8327a-faa6-4122-8710-6192ab5984ef
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"OrderDTO v5.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "depotId":{
            "type":"string",
            "description":"Depot ID.",
            "format":"uuid"
        },
        "depotVersionStart":{
            "type":"string",
            "description":"Depot version start.",
            "format":"date-time"
        },
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance ID.",
            "format":"uuid"
        },
        "orderDate":{
            "type":"string",
            "description":"Order date.",
            "format":"date-time"
        },
        "orderStatusId":{
            "type":"number",
            "description":"Order status ID.",
            "format":"double",
            "example":5
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "format":"uuid"
        },
        "studyVersionStart":{
            "type":"string",
            "description":"Study version start.",
            "format":"date-time"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "shipDate":{
            "type":"string",
            "description":"Ship date.",
            "format":"date-time"
        },
        "shipmentId":{
            "type":"string",
            "description":"ID of the shipment.",
            "example":"123"
        },
        "trackingNumber":{
            "type":"string",
            "description":"Shipment tracking number.",
            "example":"12345"
        },
        "trackingNumberUrl":{
            "type":"string",
            "description":"Tracking URL.",
            "example":"http://www.site.com"
        },
        "orderType":{
            "type":"string",
            "description":"Order type (Manual or Resupply).",
            "example":"MANUAL",
            "enum":[
                "INITIAL",
                "RESUPPLY",
                "MANUAL"
            ]
        },
        "orderTypeId":{
            "type":"integer",
            "description":"Order type ID.",
            "format":"int64",
            "example":5
        },
        "userId":{
            "type":"string",
            "description":"User ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED",
            "enum":[
                "CREATED",
                "MODIFIED",
                "REMOVED"
            ]
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number.",
            "format":"BigDecimal",
            "example":5
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number.",
            "format":"BigDecimal",
            "example":5
        },
        "reason":{
            "type":"string",
            "description":"Reason.",
            "example":"DATA ENTRY ERROR"
        },
        "comment":{
            "type":"string",
            "description":"Comment.",
            "example":"Updated with new values"
        },
        "isReconciliation":{
            "type":"boolean",
            "description":"Indicates whether kit reconciliation is included.",
            "example":true
        },
        "reportId":{
            "type":"string",
            "description":"Report ID.",
            "format":"uuid",
            "example":"b1b8327a-faa6-4122-8710-6192ab5984ef"
        },
        "isDepotShipment":{
            "type":"boolean",
            "description":"Depot shipment indicator.",
            "example":true
        },
        "shipmentReceivedById":{
            "title":"Shipment Received By ID",
            "type":"string",
            "description":"Shipment received by ID.",
            "format":"uuid"
        },
        "shippingAddressId":{
            "title":"Shipping Address ID",
            "type":"string",
            "description":"Shipping address ID.",
            "format":"uuid"
        },
        "shippingAddress":{
            "title":"Shipping Address",
            "type":"string",
            "description":"Shipping address.",
            "example":"City,Country,Local Address"
        },
        "shipmentReceiptDate":{
            "title":"Shipment Receipt Date",
            "type":"string",
            "description":"Shipment receipt date.",
            "format":"date-time"
        },
        "includePooledShipments":{
            "title":"Include Pooled Shipments",
            "type":"boolean",
            "description":"Indicates whether to include pooled shipments.",
            "example":true
        },
        "deliveryNumber":{
            "title":"Delivery Number",
            "type":"string",
            "description":"Delivery number.",
            "example":"Order123"
        },
        "orderId":{
            "type":"string",
            "description":"Order ID.",
            "format":"uuid"
        }
    },
    "description":"Contains order related details."
}

Nested Schema : InventoryDTO v3.0

Type: object

Title: InventoryDTO v3.0

Contains details of inventories.

Show Source

• blockNumber: string
  Title: Block Number

  Block number.

  Example: 245
• blocknumber: string
• doNotCount: number (double)
  Do Not Count (DNC) Days.

  Example: 5
• doNotShip: number (double)
  Do Not Ship (DNS) Days.

  Example: 5
• expirationDate: string (date-time)
  Expiration date.
• inventoryId: string (uuid)
  Inventory ID.
• inventorySourceId: string (uuid)
  Inventory ID.
• inventorySourceVersionStart: string (date-time)
  Inventory version start.
• inventoryStatusId: number (double)
  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
• kitNumber: number (double)
  Kit number.

  Example: 5
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.

  Example: 24-1
• kitTypeId: string (uuid)
  ID of the kit type.
• kitTypeVersionStart: string (date-time)
  Kit type version start date.
• labelGroupId: string (uuid)
  Label group ID.
• labelGroupVersionStart: string (date-time)
  Label group version start date.
• lotId: string (uuid)
  Lot ID.
• lotVersionStart: string (date-time)
  Lot version start date.
• sequenceNumber: number (double)
  Sequence number.

  Example: 5
• siteId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• siteVersionStart: string (date-time)
  Site version start date.
• tempExcursionNumber: string
  Title: Temperature Excursion Number

  Temperature excursion number.

  Example: 001
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"InventoryDTO v3.0",
    "type":"object",
    "properties":{
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "doNotCount":{
            "type":"number",
            "description":"Do Not Count (DNC) Days.",
            "format":"double",
            "example":5
        },
        "doNotShip":{
            "type":"number",
            "description":"Do Not Ship (DNS) Days.",
            "format":"double",
            "example":5
        },
        "expirationDate":{
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time"
        },
        "inventoryStatusId":{
            "type":"number",
            "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":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kit type version start date.",
            "format":"date-time"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group ID.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "type":"string",
            "description":"Label group version start date.",
            "format":"date-time"
        },
        "lotId":{
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "type":"string",
            "description":"Lot version start date.",
            "format":"date-time"
        },
        "sequenceNumber":{
            "type":"number",
            "description":"Sequence number.",
            "format":"double",
            "example":5
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "kitNumber":{
            "type":"number",
            "description":"Kit number.",
            "format":"double",
            "example":5
        },
        "inventorySourceId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        },
        "inventorySourceVersionStart":{
            "type":"string",
            "description":"Inventory version start.",
            "format":"date-time"
        },
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"24-1"
        },
        "blockNumber":{
            "title":"Block Number",
            "type":"string",
            "description":"Block number.",
            "example":"245"
        },
        "tempExcursionNumber":{
            "title":"Temperature Excursion Number",
            "type":"string",
            "description":"Temperature excursion number.",
            "example":"001"
        },
        "blocknumber":{
            "type":"string",
            "writeOnly":true
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory ID.",
            "format":"uuid"
        }
    },
    "description":"Contains details of inventories."
}

Nested Schema : OrdersKitTypes

Type: object

Orders Kit Types object for Pooling Supplies.

Show Source

• comment: string
  Title: Comment

  Comment.

  Example: test
• id: string (uuid)
  Order Kit Type Id for Pooling Supplies
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.
• lotNumber: string
  Title: Manufacturing Lot Number

  Manufacturing lot number.

  Example: MLOT
• minExpirationDate: string (date-time)
  Title: Effective Expiration Date

  Effective expiration date.
• objectVersionNumber: number (number)
  Title: Object Version Number

  Object version number.
• operationType: string
  Title: Operation Type

  Operation type.

  Example: modified
• pooledKitId: string
  Title: Pooled Kit ID

  Pooled kit identifier.

  Example: Pooled Kit01
• quantity: number (number)
  Title: Quantity

  Kit quantity.

  Example: 5
• reason: string
  Title: Reason

  Reason.

  Example: test
• softwareVersionNumber: number (number)
  Title: Software Version Number

  Software version number.
• userId: string (uuid)
  Title: User ID

  User ID.
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Order Kit Type Id for Pooling Supplies",
            "format":"uuid"
        },
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"number",
            "example":5
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "minExpirationDate":{
            "title":"Effective Expiration Date",
            "type":"string",
            "description":"Effective expiration date.",
            "format":"date-time"
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation type.",
            "example":"modified"
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Object version number.",
            "format":"number"
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number.",
            "format":"number"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason.",
            "example":"test"
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment.",
            "example":"test"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "pooledKitId":{
            "title":"Pooled Kit ID",
            "type":"string",
            "description":"Pooled kit identifier.",
            "example":"Pooled Kit01"
        },
        "lotNumber":{
            "title":"Manufacturing Lot Number",
            "type":"string",
            "description":"Manufacturing lot number.",
            "example":"MLOT"
        }
    },
    "description":"Orders Kit Types object for Pooling Supplies."
}

Nested Schema : NsInventoryDTO v1.0

Type: object

Title: NsInventoryDTO v1.0

Contains non-serialized kit details.

Show Source

• inventoryStatusId: number (double)
  Title: Inventory Status ID

  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
• kitTypeId: string (uuid)
  Title: Kit Type ID

  ID of the kit type.
• kitTypeVersionStart: string (date-time)
  Title: Version Start

  Kit type version start date.
• labelGroupId: string (uuid)
  Title: Label Group ID

  Label group ID.
• labelGroupVersionStart: string (date-time)
  Title: Version Start

  Label group version start date.
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.
• lotNumber: string
  Title: Lot Number

  Lot number.

  Example: lot1
• lotVersionStart: string (date-time)
  Title: Version Start

  Lot version start date.
• nsInventoryId: string (uuid)
  Title: Inventory ID

  Non-serialized inventory ID.
• objectVersionNumber: number
  Title: Object Version Number

  Object version number.

  Example: 1
• operationType: string
  Title: Operation Type

  Operation type.

  Example: CREATED
• quantity: number (double)
  Title: Quantity

  Kit quantity.

  Example: 5
• siteId: string (uuid)
  Title: Site ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
• siteVersionStart: string (date-time)
  Title: Version Start

  Site version start date.
• softwareVersionNumber: number
  Title: Software Version Number

  Software version number.

  Example: 1
• transactionId: string (uuid)
  Title: Transaction ID

  Transaction identifier of shipments.
• versionEnd: string (date-time)
  Title: Version End

  The end date until which the data is applicable or valid.
• versionStart: string (date-time)
  Title: Version Start

  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"NsInventoryDTO v1.0",
    "type":"object",
    "properties":{
        "nsInventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Non-serialized inventory ID.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time"
        },
        "inventoryStatusId":{
            "title":"Inventory Status ID",
            "type":"number",
            "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":"double",
            "example":5,
            "enum":[
                1,
                2,
                3,
                4,
                5,
                6,
                7,
                8,
                9,
                10,
                11,
                12,
                13,
                14,
                15,
                16,
                17,
                18,
                19,
                20
            ]
        },
        "kitTypeId":{
            "title":"Kit Type ID",
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        },
        "kitTypeVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Kit type version start date.",
            "format":"date-time"
        },
        "labelGroupId":{
            "title":"Label Group ID",
            "type":"string",
            "description":"Label group ID.",
            "format":"uuid"
        },
        "labelGroupVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Label group version start date.",
            "format":"date-time"
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        },
        "lotVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Lot version start date.",
            "format":"date-time"
        },
        "siteId":{
            "title":"Site ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "format":"uuid"
        },
        "siteVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Site version start date.",
            "format":"date-time"
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"double",
            "example":5
        },
        "lotNumber":{
            "title":"Lot Number",
            "type":"string",
            "description":"Lot number.",
            "example":"lot1"
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation type.",
            "example":"CREATED"
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Object version number.",
            "example":1
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number.",
            "example":1
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"string",
            "description":"Transaction identifier of shipments.",
            "format":"uuid"
        }
    },
    "description":"Contains non-serialized kit details."
}

400 Response

Invalid order status value

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 : 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