Jump to

• Request
• Response

v1.0

get

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/location/{locationId}/pendingdestructioncount

Retrieves pending destruction counts and kit type source ID available at location. Rights: OrsInventoryGet.

Request

Path Parameters

• locationId(required): string(uuid)
  Location of the kit.

  Example:

  b1b8327a-faa6-4122-8710-6192ab5984ef

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : PendingDestructionKitCountResponse v1.0

Type: object

Title: PendingDestructionKitCountResponse v1.0

Response object containing pending destruction kit counts.

Show Source

• kitTypes: array Kit Types Pending Destruction
  Title: Kit Types Pending Destruction

  List of kit types with pending destruction counts.

{
    "title":"PendingDestructionKitCountResponse v1.0",
    "type":"object",
    "properties":{
        "kitTypes":{
            "title":"Kit Types Pending Destruction",
            "type":"array",
            "description":"List of kit types with pending destruction counts.",
            "items":{
                "$ref":"#/components/schemas/PendingDestructionKitCountTO"
            }
        }
    },
    "description":"Response object containing pending destruction kit counts."
}

Nested Schema : Kit Types Pending Destruction

Type: array

Title: Kit Types Pending Destruction

List of kit types with pending destruction counts.

Show Source

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

  Pending destruction kit counts by kit type.

{
    "title":"Kit Types Pending Destruction",
    "type":"array",
    "description":"List of kit types with pending destruction counts.",
    "items":{
        "$ref":"#/components/schemas/PendingDestructionKitCountTO"
    }
}

Nested Schema : PendingDestructionKitCountTO v1.0

Type: object

Title: PendingDestructionKitCountTO v1.0

Pending destruction kit counts by kit type.

Show Source

• count: number (BigDecimal)
  Title: Pending Destruction Count

  Number of kits pending destruction.

  Example: 10
• kitTypeSourceId: string (uuid)
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  ID OF THE KIT

{
    "title":"PendingDestructionKitCountTO v1.0",
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"ID OF THE KIT",
            "format":"uuid"
        },
        "count":{
            "title":"Pending Destruction Count",
            "type":"number",
            "description":"Number of kits pending destruction.",
            "format":"BigDecimal",
            "example":10
        },
        "kitTypeSourceId":{
            "type":"string",
            "format":"uuid",
            "writeOnly":true
        }
    },
    "description":"Pending destruction kit counts by kit type."
}

Examples

Select an example Get Pending Destruction Count Response

404 Response

Invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Get Pending Destruction Count Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Get Pending Destruction Count Server Error Response

Back to Top