Jump to

• Request
• Response

v2.0

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 description 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 description 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
  Title: KitTypeQuantityTO

  Kit quantity object.

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

Nested Schema : KitTypeQuantityTO

Type: object

Title: KitTypeQuantityTO

Kit quantity object.

Show Source

• kitTypeId(required): string (uuid)
  Title: kitTypeId

  Kit type ID.
• kitTypeVersionStart: string (date-time)
  Title: kitTypeVersionStart

  Kit type version start.
• quantity(required): integer (int64)
  Title: quantity

  Minimum Value: 1

  Maximum Value: 500000

  Kit quantity.

  Example: 5

{
    "title":"KitTypeQuantityTO",
    "required":[
        "kitTypeId",
        "quantity"
    ],
    "type":"object",
    "properties":{
        "quantity":{
            "title":"quantity",
            "maximum":500000,
            "minimum":1,
            "type":"integer",
            "description":"Kit quantity.",
            "format":"int64",
            "example":5
        },
        "kitTypeVersionStart":{
            "title":"kitTypeVersionStart",
            "type":"string",
            "description":"Kit type version start.",
            "format":"date-time"
        },
        "kitTypeId":{
            "title":"kitTypeId",
            "type":"string",
            "description":"Kit type ID.",
            "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

Title: GenerateKitsResponse

Response object for kit generation.

Show Source

• inventorySourceId: string
  Title: Inventory Source ID

  Unique ID of the inventory source.

  Example: B1B8327AFAA6412287106192AB5984EF
• noOfKitsGenerated: integer (int64)
  Title: Number of Kits Generated

  Number of kits generated.

  Example: 10

{
    "title":"GenerateKitsResponse",
    "type":"object",
    "properties":{
        "inventorySourceId":{
            "title":"Inventory Source ID",
            "type":"string",
            "description":"Unique ID of the inventory source.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "noOfKitsGenerated":{
            "title":"Number of Kits Generated",
            "type":"integer",
            "description":"Number of kits generated.",
            "format":"int64",
            "example":10
        }
    },
    "description":"Response object for kit generation."
}

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 so 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
• 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

404 Response

Invalid study ID or version

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