Jump to

• Request
• Response

Get non-serialized inventory order items

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

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

Nested Schema : NSOrderInventoryResponse

Type: object

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

{
    "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"
            }
        }
    }
}

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
  Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs.

{
    "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

Type: object

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

• comment: string
• lotId: string (uuid)
• lotNumber: string
• nsInventoryId: string (uuid)
• nsInventoryVersionStart: string (date-time)
• objectVersionNumber: number
• operationType: string
• orderId: string (uuid)
• orderItemId: string (uuid)
• orderVersionStart: string (date-time)
• quantity: number
• reason: string
• shipmentNumber: string
• softwareVersionNumber: number
• transactionId: string (uuid)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "orderItemId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "nsInventoryId":{
            "type":"string",
            "format":"uuid"
        },
        "nsInventoryVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "orderId":{
            "type":"string",
            "format":"uuid"
        },
        "transactionId":{
            "type":"string",
            "format":"uuid"
        },
        "orderVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "quantity":{
            "type":"number"
        },
        "shipmentNumber":{
            "type":"string"
        },
        "lotNumber":{
            "type":"string"
        },
        "lotId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"Paginated result data for the current page. The concrete type depends on the API and typically is an array or list of DTOs."
}

404 Response

Invalid study ID

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top