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)
  ID of 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 : InventoryStatus

Type: object

Inventory status

Show Source

• inventoryStatus: string
  Allowed Values: [ "Available", " Damaged", " Destroyed", " Dispensed", " Expired", " Not in Use", " Misallocated", " Missing", " In Transit", " Quarantined", " Pre-quarantined", " Pending Destruction", " Lost by Subject", " Temporarily Unavailable", " Damaged by Subject", " New", " Not Dispensed to Subject", " Returned to Site", " Conserved", "Received for Destruction" ]

  Inventory status

  Example: New, Damaged
• inventoryStatusId: integer (int64)
  Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]

  Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

{
    "type":"object",
    "properties":{
        "inventoryStatus":{
            "type":"string",
            "description":"Inventory status",
            "example":"New, Damaged",
            "enum":[
                "Available",
                " Damaged",
                " Destroyed",
                " Dispensed",
                " Expired",
                " Not in Use",
                " Misallocated",
                " Missing",
                " In Transit",
                " Quarantined",
                " Pre-quarantined",
                " Pending Destruction",
                " Lost by Subject",
                " Temporarily Unavailable",
                " Damaged by Subject",
                " New",
                " Not Dispensed to Subject",
                " Returned to Site",
                " Conserved",
                "Received for Destruction"
            ]
        },
        "inventoryStatusId":{
            "type":"integer",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"int64",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        }
    },
    "description":"Inventory status"
}

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