Jump to

• Request
• Response

Generate kits

post

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/generate

Generates kits. Rights: DesignerKitListPost. This API contains additional attributes added in the request body for barcode implementation.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• description: string
  Minimum Length: 0

  Maximum Length: 2000

  Description of kit

  Example: Some discription of kit
• kitNumberStart(required): integer (int64)
  Minimum Value: 1

  Maximum Value: 99999999

  Kit number start value.

  Example: 5
• kitTypes(required): array kitTypes
  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647
• sequenceNumberStart(required): integer (int64)
  Minimum Value: 1

  Maximum Value: 99999999

  Sequence number start.

  Example: 5
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Title of kit

  Example: Comparative Cream--B
• useKitNumberForBarcode: boolean
  Use kit number for barcode

  Example: true
• useRandomNumberForBarcode: boolean
  Use random number for barcode

  Example: true

{
    "required":[
        "kitNumberStart",
        "kitTypes",
        "sequenceNumberStart",
        "title"
    ],
    "type":"object",
    "properties":{
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Title of kit ",
            "example":"Comparative Cream--B"
        },
        "description":{
            "maxLength":2000,
            "minLength":0,
            "type":"string",
            "description":"Description of kit ",
            "example":"Some discription of kit"
        },
        "kitTypes":{
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KitTypeQuantityTO"
            }
        },
        "kitNumberStart":{
            "maximum":99999999,
            "minimum":1,
            "type":"integer",
            "description":"Kit number start value.",
            "format":"int64",
            "example":5
        },
        "sequenceNumberStart":{
            "maximum":99999999,
            "minimum":1,
            "type":"integer",
            "description":"Sequence number start.",
            "format":"int64",
            "example":5
        },
        "useKitNumberForBarcode":{
            "type":"boolean",
            "description":"Use kit number for barcode",
            "example":true
        },
        "useRandomNumberForBarcode":{
            "type":"boolean",
            "description":"Use random number for barcode",
            "example":true
        }
    }
}

Nested Schema : kitTypes

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Show Source

• Array of: object KitTypeQuantityTO
  Kit quantity object.

{
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KitTypeQuantityTO"
    }
}

Nested Schema : KitTypeQuantityTO

Type: object

Kit quantity object.

Show Source

• kitTypeId(required): string (uuid)
  ID of the kit type.
• kitTypeVersionStart: string (date-time)
  Kit type version start
• quantity(required): integer (int64)
  Minimum Value: 1

  Maximum Value: 500000

  Kit quantity.

  Example: 5

{
    "required":[
        "kitTypeId",
        "quantity"
    ],
    "type":"object",
    "properties":{
        "quantity":{
            "maximum":500000,
            "minimum":1,
            "type":"integer",
            "description":"Kit quantity.",
            "format":"int64",
            "example":5
        },
        "kitTypeVersionStart":{
            "type":"string",
            "description":"Kit type version start",
            "format":"date-time"
        },
        "kitTypeId":{
            "type":"string",
            "description":"ID of the kit type.",
            "format":"uuid"
        }
    },
    "description":"Kit quantity object."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : GenerateKitsResponse

Type: object

Response object of generate kit

Show Source

• inventorySourceId: string
  Unique Id of inventory

  Example: B1B8327AFAA6412287106192AB5984EF
• noOfKitsGenerated: integer (int64)
  Numbers of kit generated

  Example: 10

{
    "type":"object",
    "properties":{
        "inventorySourceId":{
            "type":"string",
            "description":"Unique Id of inventory",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "noOfKitsGenerated":{
            "type":"integer",
            "description":"Numbers of kit generated",
            "format":"int64",
            "example":10
        }
    },
    "description":"Response object of generate kit"
}

400 Response

The Title has already been used OR Invalid kit type OR The maximum number of rows requested shall not exceed 500000 OR Some numbers in this list are used in another kit list. Adjust the first kit or sequence number to that the values don't overlap with existing numbers. OR 1 or more sequence numbers already exist OR 1 or more kit numbers already exist OR The CSV might contain duplicate kit number(s) or sequence number(s).

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

404 Response

Invalid study ID or version

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