Jump to

• Request
• Response

v1.0

post

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

Generates kits. Rights: DesignerKitListPost.

Request

Path Parameters

• 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

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",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "quantity":10
                }
            ],
            "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",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "quantity":10
        }
    ],
    "items":{
        "$ref":"#/components/schemas/KitTypeQuantityTO"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "quantity":10
    }
]

Nested Schema : KitTypeQuantityTO

Type: object

Title: KitTypeQuantityTO

Kit quantity object.

Show Source

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

  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":[
        "id",
        "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"
        },
        "id":{
            "title":"id",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        }
    },
    "description":"Kit quantity object.",
    "example":{
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "quantity":10
    }
}

Example:

{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "quantity":10
}

Examples

Select an example Generate Kits Request

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

Examples

Select an example Generate Kits Response

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
  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 Generate Kits Bad Request 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 Generate Kits 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 Generate Kits Server Error Response

Back to Top