Jump to

• Request
• Response

v1.0

get

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

Retrieves all order items for non-serialized inventory.
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

• audit(required): boolean
• limit: integer(int32)
  Minimum Value: 1
• nsInventoryId: string(uuid)
• offset: integer(int32)
  Minimum Value: 0
• orderId: string(uuid)

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

  Contains non-serialized order inventory response.

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

Nested Schema : NSOrderInventoryResponse

Type: object

Title: NSOrderInventoryResponse

Contains non-serialized order inventory response.

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.
• totalResults: integer (int32)
  Total number of results across all pages.

  Example: 125

{
    "title":"NSOrderInventoryResponse",
    "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/OrderNSInventoryTO"
            }
        }
    },
    "description":"Contains non-serialized order inventory response."
}

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

  Contains non-serialized order inventory 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/OrderNSInventoryTO"
    }
}

Nested Schema : OrderNSInventoryTO v1.0

Type: object

Title: OrderNSInventoryTO v1.0

Contains non-serialized order inventory details.

Show Source

• comment: string
  Title: Comment

  Comment.
• lotId: string (uuid)
  Title: Lot ID

  Lot ID.
• lotNumber: string
  Title: Lot Number

  Lot number.
• nsInventoryId: string (uuid)
  Title: Inventory ID

  Non-serialized inventory ID.
• nsInventoryVersionStart: string (date-time)
  Title: Version Start

  Non-serialized inventory version start timestamp.
• objectVersionNumber: number
  Title: Object Version Number

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

  Operation type.
• orderId: string (uuid)
  Title: Order ID

  Order ID.
• orderItemId: string (uuid)
  Title: Order Item ID

  Order item identifier.
• orderVersionStart: string (date-time)
  Title: Version Start

  Order version start date.
• quantity: number
  Title: Quantity

  Kit quantity.
• reason: string
  Title: Reason

  Reason.
• shipmentNumber: string
  Title: Shipment Number

  Shipment number.
• softwareVersionNumber: number
  Title: Software Version Number

  Software version number.
• transactionId: string (uuid)
  Title: Transaction ID

  Transaction identifier of shipments.
• userId: string (uuid)
  Title: User ID

  User ID.
• versionEnd: string (date-time)
  Title: Version End

  Version end date.
• versionStart: string (date-time)
  Title: Version Start

  Version start date.

{
    "title":"OrderNSInventoryTO v1.0",
    "type":"object",
    "properties":{
        "orderItemId":{
            "title":"Order Item ID",
            "type":"string",
            "description":"Order item identifier.",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Version start date.",
            "format":"date-time"
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Version end date.",
            "format":"date-time"
        },
        "nsInventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Non-serialized inventory ID.",
            "format":"uuid"
        },
        "nsInventoryVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Non-serialized inventory version start timestamp.",
            "format":"date-time"
        },
        "orderId":{
            "title":"Order ID",
            "type":"string",
            "description":"Order ID.",
            "format":"uuid"
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"string",
            "description":"Transaction identifier of shipments.",
            "format":"uuid"
        },
        "orderVersionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Order version start date.",
            "format":"date-time"
        },
        "operationType":{
            "title":"Operation Type",
            "type":"string",
            "description":"Operation type."
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Object version number."
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number."
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason."
        },
        "comment":{
            "title":"Comment",
            "type":"string",
            "description":"Comment."
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity."
        },
        "shipmentNumber":{
            "title":"Shipment Number",
            "type":"string",
            "description":"Shipment number."
        },
        "lotNumber":{
            "title":"Lot Number",
            "type":"string",
            "description":"Lot number."
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "format":"uuid"
        }
    },
    "description":"Contains non-serialized order inventory details."
}

404 Response

Invalid study 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